Skip to main content

Get the contacts for the given organisation

GET 
/organisations/:OrganisationId/contacts

get all contacts for an organisations

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

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

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​

Paged Contacts Snapshot

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • ContactId string

    Possible values: Value must match regular expression ^[^<>]*$

    Unique contact ID for the row.

    OrganisationId OrganisationId (string)

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

    Unique ID associated with the organisation

    ContactType ContactType (string)

    Possible values: Value must match regular expression ^[^<>]*$

    Default value: Business

    The type of Contact, default contact type is Business.

    FirstName string

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

    LastName string

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

    Department string

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

    EmailAddress string

    Possible values: <= 255 characters, Value must match regular expression ^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$

    PhoneNumber string

    Possible values: <= 18 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

    AdditionalInformation string

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

    Any additional user information

    PgpPublicKey string

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

    A PGP Public Key in text form

  • ]

    • 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...