> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: e6d03756-79bf-4e4d-8cbb-91b51af22ca8
---
# Fetch List Memberships Ordered by Added to List Date
> Fetch the memberships of a list in order sorted by the time the records were added to the list.
The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order.
The `after` offset parameter will take precedence over the `before` offset in a case where both are provided.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/legacy/v3/crm-lists-v3.json GET /crm/v3/lists/{listId}/memberships/join-order
openapi: 3.0.1
info:
title: CRM Lists
description: CRUD operations to manage lists and list memberships
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-related-documentation:
- name: Lists Guide
url: https://developers.hubspot.com/docs/guides/api/crm/lists/overview
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
- name: Batch
- name: Search
paths:
/crm/v3/lists/{listId}/memberships/join-order:
get:
tags:
- Basic
summary: Fetch List Memberships Ordered by Added to List Date
description: >-
Fetch the memberships of a list in order sorted by the time the records
were added to the list.
The `recordId`s are sorted in *ascending* order if an `after` offset or
no offset is provided. If only a `before` offset is provided, then the
records are sorted in *descending* order.
The `after` offset parameter will take precedence over the `before`
offset in a case where both are provided.
operationId: >-
get-/crm/v3/lists/{listId}/memberships/join-order_/crm/v3/lists/{listId}/memberships/join-order
parameters:
- name: listId
in: path
description: The **ILS ID** of the list.
required: true
style: simple
explode: false
schema:
type: string
- name: after
in: query
description: >-
The paging offset token for the page that comes `after` the
previously requested records.
If provided, then the records in the response will be the records
following the offset, sorted in *ascending* order. Takes precedence
over the `before` offset.
required: false
style: form
explode: true
schema:
type: string
- name: before
in: query
description: >-
The paging offset token for the page that comes `before` the
previously requested records.
If provided, then the records in the response will be the records
preceding the offset, sorted in *descending* order.
required: false
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: >-
The number of records to return in the response. The maximum `limit`
is 250.
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCollectionResponseJoinTimeAndRecordId'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- crm.segments.read
- oauth2:
- crm.lists.read
components:
schemas:
ApiCollectionResponseJoinTimeAndRecordId:
required:
- results
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
results:
type: array
items:
$ref: '#/components/schemas/JoinTimeAndRecordId'
total:
type: integer
description: The total number of records that match the query.
format: int64
Paging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
prev:
$ref: '#/components/schemas/PreviousPage'
description: The cursor to be used for paging through records.
JoinTimeAndRecordId:
required:
- membershipTimestamp
- recordId
type: object
properties:
membershipTimestamp:
type: string
description: The date and time when the record was added to the list.
format: date-time
recordId:
type: string
description: The unique identifier of the record.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
NextPage:
required:
- after
type: object
properties:
after:
type: string
description: The offset for the next page of records.
link:
type: string
description: A direct link to the request for the next page of records.
description: >-
Specifies the paging information needed to retrieve the next set of
results in a paginated API response
PreviousPage:
required:
- before
type: object
properties:
before:
type: string
description: The offset of the previous page of records.
link:
type: string
description: A direct link to the request for the previous page of records.
description: >-
specifies the paging information needed to retrieve the previous set of
results in a paginated API response
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
cms.membership.access_groups.write: ''
crm.lists.read: ''
crm.lists.write: ''
crm.segments.read: ''
crm.segments.write: ''
````
{product.name} -
{product.level}
)}