Skip to main content
GET
/
api
/
v1
/
ranks
List
curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/ranks/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "minimum_differential": -1,
      "audience_type": 123,
      "mona_version": 123
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
mona_version__audience_type
enum<integer>
  • 0 - None
  • 1 - Customers
  • 2 - Employees
  • 3 - Donors
  • 4 - Media
  • 5 - Gathering 2024 Lecturees
Available options:
0,
1,
2,
3,
4,
5
​
mona_version__id
integer
​
mona_version__sequence
integer
​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"