Skip to content
emely. docs

/v1/societies

GET
/v1/societies
curl --request GET \
  --url 'https://api.emely.io/v1/societies?active=true&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
active
string
Allowed values: true false
country
string
q
string
limit
integer
default: 50 >= 1 <= 200
offset
integer | null
0

Responses

Section titled “ Responses ”

200

Section titled “200”

Paginated society catalogue entries

Media typeapplication/json
object
items
required
Array<object>
object
code
required
string
name
required
string
kind
required
string
homeCountryCode
required
string | null
cisacCode
required
string | null
active
required
boolean
limit
required
integer
offset
required
integer
total
required
integer
Examplegenerated
{
  "items": [
    {
      "code": "example",
      "name": "example",
      "kind": "example",
      "homeCountryCode": "example",
      "cisacCode": "example",
      "active": true
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

400

Section titled “400”

Invalid query parameters

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

401

Section titled “401”

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

403

Section titled “403”

Token role refused upstream

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

502

Section titled “502”

Upstream error

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}