Skip to main content
GET
/
waap
/
v1
/
organizations
Retrieve a list of network organizations
curl --request GET \
  --url https://api.gcore.com/waap/v1/organizations \
  --header 'Authorization: <api-key>'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

​
ordering
enum<string> | null

Determine the field to order results by

Available options:
name,
id,
-name,
-id
Example:

"name"

​
limit
integer
default:100

Number of items to return

Required range: 0 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 100000
​
name
string

Filter organizations by their name. Supports '*' as a wildcard character.

Example:

"Comcast"

Response

Successful Response

​
limit
integer
required

Number of items requested in the response

​
offset
integer
required

Items response offset used

​
count
integer
required

Number of items contain in the response

​
results
Organization · object[]
required

List of items returned in the response following given criteria