Organizations

List organizations available to the token

GET /api/v1/organizations

Parameters

Name	In	Type	Required	Description
`limit`	query	integer	No	Maximum number of items to return.
`offset`	query	integer	No	Number of items to skip.

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/organizations?limit=<limit>&offset=<offset>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Other statuses: 401, 403.

Response body type

{ data: Organization[] }

Get organization by WorkOS id

GET /api/v1/organizations/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	—

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/organizations/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "id": "string",
    "name": "string"
  }
}

Other statuses: 401, 403, 404.

Response body type

{ data: Organization }