Skip to main content

Get all organisations that the logged in user is authorised to retrieve from trusted services

GET 
/organisations

get all organisations the token is authorised to retrieve

Request​

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

    displayMine string

    Set to an email value to instruct the backend to only return organisations related to the user

    filterBy string

    Will return organisations with data like the provided value

    hideInactive boolean

    Will return only active organisations

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(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)$

    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

    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.

Responses​

All organisations

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • OrganisationId OrganisationId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the organisation

    Status string

    Possible values: [Active, Pending, Withdrawn]

    Default value: Active

    Status of the directory registration of an organisation

    OrganisationName string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Name of the organisation.

    CreatedOn string

    Possible values: <= 30 characters

    JSONDatetime of organisation creation.

    LegalEntityName string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Legal Entity name for the org. Usually the same as org name

    CountryOfRegistration string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Country of registration for the org

    CompanyRegister string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Legal company register for the country, i.e. Companies House

    Size string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Size of the organisation

    RegistrationNumber string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Company registration number from company register i.e. Companies House registration number

    RegistrationId string

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Registered ID for the organisation i.e. Legal Entity identifier number

    RegisteredName string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    AddressLine1 string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Address line 1

    AddressLine2 string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Address line 2

    City string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    City

    Postcode string

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Postcode

    Country string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Country

    ParentOrganisationReference string

    Possible values: <= 65535 characters, Value must match regular expression ^[^<>]*$

    Parent Organisation Reference

    RequiresParticipantTermsAndConditionsSigning boolean

    true - this organisation requires terms and conditions to be signed. false - this organisation does not require terms and conditions to be signed

    LogoUri uri

    Possible values: Value must match regular expression ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$

    A compliant URI

    Flags

    object[]

  • Array [

    • Id FlagID (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID of the flag

    CreatedAt date-time
    UpdatedAt date-time

  • ]

  • ]

    • totalPages integer
    totalSize integer

    pageable

    object

    number integer

    Page number

    sort

    object

    sorted boolean

    orderBy

    object[]

  • Array [

    • property string

    Name of the property used for sorting

    direction string

    Possible values: [ASC, DESC]

    Direction of sort, i.e. ascending or descending

    ignoreCase boolean

    Was the case ignored

    ascending boolean

    Whether ascending

  • ]

    • size integer

    Size of the page

    offset integer

    Offset

    sorted boolean

    Is the page sorted

    unpaged boolean

    Is this an unpaged response

    numberOfElements integer
    size integer
    offset integer
    empty boolean
    pageNumber integer
Loading...