Skip to main content
GET
/
api
/
v1
/
profiles
Get Profiles
curl --request GET \
  --url https://sandbox.oumla.com/api/v1/profiles \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "reference": "<string>",
      "type": "<string>"
    }
  ],
  "pagination": {
    "totalElements": 100,
    "totalPages": 10,
    "skip": 0,
    "take": 10
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain your API key from the dashboard.

Headers

x-sdk-version
string
default:1.0.0

SDK version header

Query Parameters

skip
integer
default:0

Number of records to skip

Required range: x >= 0
take
integer
default:10

Number of records to take

Required range: 1 <= x <= 100

Response

Profiles retrieved successfully

Profiles response object

data
object[]
pagination
object

Pagination