Get entities from Roles

GET 
https://api.elfsquad.io/data/1/Roles

Get entities from Roles

Request

Query Parameters

$top integer

Possible values: >= 0

Show only the first n items

$skip integer

Possible values: >= 0

Skip the first n items

$filter string

Filter items by property values

$count boolean

Include count of items

$orderby string[]

Possible values: [name, name desc, description, description desc, permissions, permissions desc, type, type desc, id, id desc, createdDate, createdDate desc, updatedDate, updatedDate desc, organizationId, organizationId desc, reference, reference desc, creatorId, creatorId desc, customField1, customField1 desc, customField2, customField2 desc, customField3, customField3 desc, customField4, customField4 desc, customField5, customField5 desc]

Order items by property values

$select string[]

Possible values: [name, description, permissions, type, id, createdDate, updatedDate, organizationId, reference, creatorId, customField1, customField2, customField3, customField4, customField5, organization]

Select properties to be returned

$expand string[]

Possible values: [*, organization]

Expand related entities

Responses

200

Retrieved entities

application/json

Schema

Schema

value object[]
Array [
namestring
descriptionstring
permissionsstring[]
type
iduuid
createdDatedate-time
updatedDatedate-time
organizationIduuid
referencestring
creatorIduuid
customField1string
customField2string
customField3string
customField4string
customField5string
organization
]

Example (auto)

{
  "value": [
    {
      "name": "string",
      "description": "string",
      "permissions": [
        "string"
      ],
      "type": {},
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdDate": "2024-07-29T15:51:28.071Z",
      "updatedDate": "2024-07-29T15:51:28.071Z",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "string",
      "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string",
      "organization": {}
    }
  ]
}

default

error

application/json

Schema

Schema

error objectrequired

codestringrequired

messagestringrequired

targetstring

details object[]

Array [

codestringrequired

messagestringrequired

targetstring

]

innererrorobject

The structure of this object is service-specific

Example (auto)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.elfsquad.io/data/1/Roles");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.elfsquad.io/data/1

Parameters

$top — query

$skip — query

$filter — query

$count — query

---truefalse

$orderby — query

namename descdescriptiondescription descpermissionspermissions desctypetype descidid desccreatedDatecreatedDate descupdatedDateupdatedDate descorganizationIdorganizationId descreferencereference desccreatorIdcreatorId desccustomField1customField1 desccustomField2customField2 desccustomField3customField3 desccustomField4customField4 desccustomField5customField5 desc

$select — query

namedescriptionpermissionstypeidcreatedDateupdatedDateorganizationIdreferencecreatorIdcustomField1customField2customField3customField4customField5organization

$expand — query

*organization

ResponseClear

Click the Send API Request button above and see the response here!