NarAssociations: GetNarAssociations

Returns a list of National Association of REALTORS® member associations, such as state and local associations.

Permissions

Any user who has a valid access token can use this method.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/forms/nar_associations

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Optional Query Parameters
countinteger

(Optional) The number of results to return. This value must be a number between 1 and 100 (default).

startPositioninteger

(Optional) The starting, zero-based index position in the result set from which to start returning values. The default is 0.

Responses

CodeDescriptionReference
200

Successfully retrieved Nar Associations.

NarAssociationSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

NarAssociations::GetNarAssociations

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

NarAssociationSummary

Contains details about a NAR association.

narAssociationIdstring

The id of the NAR association.

Example: 3775

namestring

The name of the NAR association.

Example: MAINSTREET ORGANIZATION OF REALTORS®

NarAssociationSummaryList

Contains a list of NAR associations.

narAssociations[NarAssociationSummary]

A list of NAR associations.

resultSetSizeinteger

The number of results returned in this response.

startPositioninteger

The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is 0.

endPositioninteger

The last zero-based index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. This property is null for the last set of search results.

priorUristring

The URI for the previous chunk of records based on the search request. This property is null for the first set of search results.

}} />