Get users by organization

GET 
https://api.astropulse.io/internal/v1/organizations/:orgId/users

Get a paginated list of users in an organization

Request

Path Parameters

orgId stringrequired

Organization ID

Query Parameters

page integer

Page number (default: 1)

pageSize integer

Items per page (default: 10)

Responses

200

Users retrieved successfully

application/json

Schema

Schema

data object
pagination object
currentPageinteger
hasNextPageboolean
itemsPerPageinteger
totalIteminteger
totalPagesinteger
users object[]
Array [
emailstring
joinedAtstring
namestring
orgIdstring
planIdstring
rolestring
userIdstring
]
idstring
messagestring
statusstring

Example (auto)

{
  "data": {
    "pagination": {
      "currentPage": 0,
      "hasNextPage": true,
      "itemsPerPage": 0,
      "totalItem": 0,
      "totalPages": 0
    },
    "users": [
      {
        "email": "string",
        "joinedAt": "string",
        "name": "string",
        "orgId": "string",
        "planId": "string",
        "role": "string",
        "userId": "string"
      }
    ]
  },
  "id": "string",
  "message": "string",
  "status": "string"
}

400

Invalid organization ID or pagination parameters

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

401

Missing or invalid authorization token

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

403

User does not have permission to list organization users

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

404

Organization not found

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

500

Internal server error

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

• 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.astropulse.io/internal/v1/organizations/:orgId/users");
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.astropulse.io

Parameters

orgId — pathrequired

page — query

pageSize — query