Returns all api families configured at a reference data level

GET /references/apifamilies
O auth

Headers

  • x-fapi-auth-date string

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.

  • x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

  • x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Query parameters

  • page integer

    The page number to return of the result set

  • size integer

    The size of the pages to return

  • sort string

    The field name to sort

  • name string

    The name of the api family

    Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

  • certification boolean

    A boolean that represents api families that have automatic certification

  • version string

    A string that represents the version of the api families

  • status string

    The status of the api family

    Values are Active or Inactive. Default value is Active.

GET /references/apifamilies 
curl \
 --request GET 'https://matls-api.sandbox.raidiam.io/references/apifamilies' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "x-fapi-auth-date: string" \
 --header "x-fapi-customer-ip-address: string" \
 --header "x-fapi-interaction-id: string" \
 --header "x-customer-user-agent: string"