GET
/
v1
/
organizations
curl --request GET \
  --url https://{environment}.straddle.io/v1/organizations \
  --header 'Authorization: <api-key>'
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc"
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "external_id": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.

Headers

​
request-id
string

Optional client generated identifier to trace and debug a request.

​
correlation-id
string

Optional client generated identifier to trace and debug a series of requests.

Query Parameters

​
name
string

List organizations by name (partial match supported).

​
external_id
string

List organizations by their external ID.

​
page_number
integer
default:
1
required

Results page number. Starts at page 1. Default value: 1

​
page_size
integer
default:
100
required

Page size. Default value: 100. Max value: 1000

​
sort_by
string
default:
id
required

Sort By. Default value: 'id'.

​
sort_order
enum<string>
default:
asc
required

Sort Order. Default value: 'asc'.

Available options:
asc,
desc

Response

200
text/plain
OK
​
meta
object
required
​
response_type
enum<string>
required

Indicates the type of data returned.

Available options:
object,
array,
error,
none
​
data
object[]
required

Was this page helpful?

Suggest editsRaise issue
Create an organizationCreate an account