GET
/
v1
/
organizations
curl --request GET \
  --url https://api.edgee.app/v1/organizations \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "<string>",
  "has_more": true,
  "last_key": "<string>",
  "data": [
    {
      "object": "organization",
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "avatar_url": "<string>",
      "type": "perso",
      "current_billing_plan": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token. More info here

Query Parameters

​
name
string

The name of the organization.

​
limit
integer

A limit on the number of objects to be returned.

​
start_key
string

A cursor for use in pagination. start_key parameter defines the place in the list for your subsequent calls. For instance, if you make a list request and receive 100 objects, the last one having ABCDE key, you can make a subsequent call with start_key=ABCDE in order to fetch the next page of the list.

​
order_direction
enum<string>

The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.

Available options:
ASC,
DESC

Response

200
application/json
A list of Organizations
​
object
string

String representing the object’s type. Objects of the same type share the same value.

Example:

"list"

​
url
string

The URL where this list can be accessed.

​
has_more
boolean

Whether there are more objects beyond the ones returned. You can use it to decide whether to show the user a “load more” button, for example.

​
last_key
string

The last key of the list. You can use its value on the start_key parameter to fetch the next page of the list.

​
data
object[]

Was this page helpful?

Suggest editsRaise issue