Skip to main content
GET
/
api
/
v1
/
segments
/
List
curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/segments/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "portfolio": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "configurations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "report_name": "<string>",
          "report_issued_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.

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
portfolio_id
string<uuid>

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"