GET /endpoints
Requires authentication with server access token.
Get a list with descriptions of all endpoints.
You can also fetch information about a single endpoint, but this is merely a network efficiency feature. The exact same information is provided (i.e., there are no further details than what's available from the full listing), but the payload is much smaller than fetching the whole listing.
See also
Help us improve
Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.
Request
GET /api/2/endpoints
name | optionalThe name of the endpoint (see the full endpoint listing for names) |
---|---|
url | optionalThe url of the endpoint to describe (see the full endpoint listing for names) |
Example request
curl
Minimal example
curl https://login.schibsted.com/api/2/endpoints -G \
-H "Authorization: Bearer [access token]"
With all parameters
curl https://login.schibsted.com/api/2/endpoints -G \
-H "Authorization: Bearer [access token]" \
-d "name={"givenName":"John","familyName":"Doe","formatted":"John Doe"}" \
-d "url=http://example.com"
Response
This endpoint supports the JSON and JSON-P response formats.
Success: 200 OK
A list of endpoint objects
Endpoint
Endpoint description. Provides information about the API itself. Most of this information is displayed in the API documentation you are now reading.
category ✓ | list of stringsThe service and API this endpoint is categorized under. |
---|---|
name ✓ | stringHuman-readable name of endpoint. |
path ✓ | stringThe API-relative path, e.g. without the leading /api/2 |
pathParameters ✓ | list of stringsA list of parameters used in the path |
method ✓ | stringAllowable methods, GET, POST, DELETE or '*', e.g. multiple methods. See http-methods for details. |
url ✓ | stringThe full absolute path to this endpoint. |
valid_output_formats ✓ | stringPossible ouput formats. Use by sending format=[name] as a request parameter. |
default_output_format ✓ | stringThe default output format, typically |
parameterDescriptions ✓ | objectAn object with parameter docstrings. The property names of this object are names of either request parameters or path parameters, and the value is a description of the parameter's purpose. |
alias | objectSome parameters have aliases; names that may be used in their place. The property names in this object are parameter names and the value denotes which parameter it will map to. |
deprecated | stringIf deprecated, this string will indicate from which version it was deprecated. |
httpMethods ✓ | HTTP methodDetails about the supported HTTP methods with their purpose and possible outcomes. |
controller ✓ | stringThe server-side controller. Should be ignored. |
description ✓ | string |
The check mark ✓ indicates that the field always contains a valid non-empty value.
HTTP method
A supported endpoint action
name ✓ | stringThe HTTP method (only GET, POST and DELETE are used by the API) |
---|---|
optional ✓ | list of stringsA list of optional request parameters. |
required ✓ | list of stringsA list of required request parameters. |
responses ✓ | list of Endpoint responsesA list of possible outcomes of taking this action. |
filters ✓ | list of stringsSupported filters. |
defaultFilters ✓ | list of stringsDefault filters. |
accessTokenTypes ✓ | list of stringsSupported token types. May be server, user or both. If both, then this action may be taken with either access token type. |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Endpoint response
A possible response from the API
status ✓ | integerThe HTTP response code |
---|---|
description ✓ | stringA description of what this response signifies, and in which cases it may arise |
type ✓ | stringThe symbolic name of the formal type returned as |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Failure cases
Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.
- 400 Bad Request url parameter did not match any endpoints
- 400 Bad Request name parameter did not match any endpoints
- 401 Unauthorized You don't have administration rights for this client.
- 401 Unauthorized Your client doesn't have administration rights for this client.
- 403 Forbidden Client is not authorized to access this API endpoint. Contact Schibsted account to request access.
- 403 Forbidden Requesting IP is not whitelisted
- 403 Forbidden Access token rejected
- 404 Not Found Unknown client ID
- 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
- 420 Request Ratelimit exceeded
Sample response
JSON
[
{
"path": "endpoints",
"valid_output_formats": [
"json"
],
"method": "GET",
"name": "Utility:endpoints",
"httpMethods": {
"GET": {
"name": "GET",
"required": [],
"optional": [
"name"
]
}
},
"url": "/api/2/endpoints",
"pathParameters": [],
"controller": "Api/2/Utility.endpoints",
"default_output_format": "json",
"description": "List all api endpoints, or get info on single endpoint (specify name or url)"
}
]
JSON-P
callback([
{
"path": "endpoints",
"valid_output_formats": [
"json"
],
"method": "GET",
"name": "Utility:endpoints",
"httpMethods": {
"GET": {
"name": "GET",
"required": [],
"optional": [
"name"
]
}
},
"url": "/api/2/endpoints",
"pathParameters": [],
"controller": "Api/2/Utility.endpoints",
"default_output_format": "json",
"description": "List all api endpoints, or get info on single endpoint (specify name or url)"
}
]);
Comments/feedback
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. Our team reads and responds to every question. Additionally, your experience can help others using Schibsted account, and it can help us continuously improve our documentation.