Find organisations matching a name prefix.

GET 
/suggestions

Available in plans: Playground · Swiss Registry · Swiss Registry Signatory · Swiss Registry Signatory Excerpt · Partner

Returns a list of organisation name and uid pairs, with the name matching the given prefix. The fuzzy search is performed in the ZEFIX and the UID registers. When searching for an exact UID (format CHE-123.456.789), the exact match will be returned if it exists instead.

Proposed Usage

• Trigger this method after a certain amount of inactivity on the client side or by an explicit user action.
• The call will return a list of suggestions which can be rendered into a drop-down, for example, to support the user to find the desired organisation.
• To keep the information for the user / the drop-down size in check, the number of the returned suggestions can be limited by the limit query parameter.
• We disclaim any legal liability for any damages or consequences that may result from the use of the data provided.

Usage Limits

• This endpoint is rate limited, please refer to the response headers for further details on limits and reset times.

Request

Responses

200

List of organisations matching the search prefix

Response Headers

RateLimit-Policy
The rate limit policy applied to this request
Example: 10;w=60
RateLimit-Limit
The rate limit for this endpoint
Example: 10
RateLimit-Remaining
The number of requests remaining in the current rate limit window
Example: 7
RateLimit-Reset
The amount of seconds before the rate limit window requests
Example: 39
RateLimit-Origin
Origin of the 429 rate limit (e.g. Jupi or when absent; other gateway like DMP)
Example: jupi

400

Invalid request parameters

Response Headers

RateLimit-Policy
The rate limit policy applied to this request
Example: 10;w=60
RateLimit-Limit
The rate limit for this endpoint
Example: 10
RateLimit-Remaining
The number of requests remaining in the current rate limit window
Example: 7
RateLimit-Reset
The amount of seconds before the rate limit window requests
Example: 39
RateLimit-Origin
Origin of the 429 rate limit (e.g. Jupi or when absent; other gateway like DMP)
Example: jupi

429

The API returns the error message when the quota for the resource has been exhausted. The detail in the response must provide information about the service quota allocated and renewal interval. When this error is returned, the request should not be retried within the same quota interval.

Response Headers

RateLimit-Policy
The rate limit policy applied to this request
Example: 10;w=60
RateLimit-Limit
The rate limit for this endpoint
Example: 10
RateLimit-Remaining
The number of requests remaining in the current rate limit window
Example: 7
RateLimit-Reset
The amount of seconds before the rate limit window requests
Example: 39
RateLimit-Origin
Origin of the 429 rate limit (e.g. Jupi or when absent; other gateway like DMP)
Example: jupi

500

Internal server error

Response Headers

RateLimit-Policy
The rate limit policy applied to this request
Example: 10;w=60
RateLimit-Limit
The rate limit for this endpoint
Example: 10
RateLimit-Remaining
The number of requests remaining in the current rate limit window
Example: 7
RateLimit-Reset
The amount of seconds before the rate limit window requests
Example: 39
RateLimit-Origin
Origin of the 429 rate limit (e.g. Jupi or when absent; other gateway like DMP)
Example: jupi