Reports

Get Report Data by Report Id.

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Query parameters

SortDirectionall ofOptional

parameter to sort data ascending or descending. Default is descending.

string · enumOptionalPossible values:

SortByFieldstringOptional

Parameter of what field to sort by. the parameter string is case insensitive and should match the reports field name.

Example: accountNumber

PageSizeinteger · int32Optional

Page Size

Example: 20

PageNumberinteger · int32Optional

Page Number

Example: 1

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get

/Reports/{id}/Data

HTTPcURLJavaScriptPython

GET /Reports/{id}/Data HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Get Reports

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Query parameters

FilterstringOptional

Filter the results. See developer resources for more information

Example: name eq 'Adam' and age gt 20

OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 2025-12-01

ModifiedBeforestring · date-timeOptional

Apply a separate filter to only get records that has been modified Before the specified date time.

Example: 2025-12-01

PageSizeinteger · int32Optional

Page Size

Example: 20

PageNumberinteger · int32Optional

Page Number

Example: 1

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get

/Reports

HTTPcURLJavaScriptPython

GET /Reports HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "entityName": "text",
      "fields": [
        "text"
      ]
    }
  ]
}

Get Reports by Id

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get

/Reports/{id}

HTTPcURLJavaScriptPython

GET /Reports/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "entityName": "text",
  "fields": [
    "text"
  ]
}

---