Get All Users
GET/users
Fetches all SDP users within the organization, whether they are active yet or not.
Responses
- 200
- 401
- 403
Returns a paginated list of User Details
- application/json
- Schema
- Example (auto)
Schema
- Array [
- ]
idstringrequired
Example:
1736bed3-7b92-4760-8ff2-51fb08ee079f
first_namestringrequired
Example:
John
last_namestringrequired
Example:
Doe
emailstringrequired
rolesstring[]required
is_activebooleanrequired
[
[
{
"id": "7a4c6555-1f73-49b3-a211-f95bd2b8ec90",
"first_name": "John",
"last_name": "Doe",
"email": "email@email.com",
"roles": [
"developer"
],
"is_active": true
},
{
"id": "5f4df1dd-c84f-482a-84ad-541ffd46e75a",
"first_name": "Jane",
"last_name": "Doe",
"email": "email@email.com",
"roles": [
"financial_controller"
],
"is_active": false
}
]
]
Unauthorized
- application/json
- Schema
- Example (auto)
- Example
Schema
errorstring
extras object
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
Forbidden
- application/json
- Schema
- Example (auto)
- Example
Schema
errorstring
{
"error": "Forbidden"
}
{
"error": "Forbidden"
}
Authorization: Authorization
name: Authorizationtype: apiKeydescription: JWT used for authentication, signed with an ES256 private key.in: header
- 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, "/users");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
ResponseClear
Did you find this page helpful?