# List referrals

`GET https://api.nexus.gg/v1/referrals/`

Returns one `page` of the `referrals` recorded for a creator group. Paging starts at `page` 1, and returns up to 100 `referrals` per `page` unless you pass `pageSize`. Use `totalCount` to work out how many pages there are. This method authenticates with a **secret** (`nexus_sk_...`) key.

## Authorizations

- `X-SHARED-SECRET` (string, header, required) - Send your **secret** API key (`nexus_sk_...`) in the `X-SHARED-SECRET` header. [Generate one](/authentication/api-keys/) in the Publisher Dashboard.

## Query parameters

- `groupId` (string) - Creator group to use for this operation. If your key is scoped to a single program, that group is always used regardless of this value; otherwise falls back to your default group when omitted.
- `page` (integer) - Page of records to return
- `pageSize` (integer) - Maximum number of records to return

## Responses

### 200

Results matching criteria

#### Body (`application/json`)

- `groupId` (string) - ID of the creator group
- `groupName` (string) - Name of the creator group
- `currentPage` (integer) - Page number of response records returned
- `currentPageSize` (integer) - Page size used for this operation
- `totalCount` (integer) - Total number of referrals
- `referrals` (array of object)

### 400

Bad request

#### Body (`application/json`)

- `code` (string) - CodeNotInGroup: Creator group is private, and specified code is not linked to it<br /> InvalidGroup: No creator group was found with the specified groupId<br/> InvalidAuthCode: AuthCode provided is not valid<br/> ExpiredAuthCode: AuchCode provided has expired<br/> ReferralNexusNotFound: No Nexus was found to match the provided referral code Allowed values: InvalidGroup, CodeNotInGroup, InvalidAuthCode, ExpiredAuthCode, ReferralNexusNotFound, UnknownError.
- `message` (string)