Skip to content

Elevate Authentication & Users API (1.5)

Authentication

Elevate API uses Bearer authentication (also called token authentication) - this is an HTTP authentication scheme that uses security tokens called bearer tokens The bearer tokens used by Elevate are the industry standard JSON Web Tokens (JWT)

The client can obtain the token from this endpoint and must send this token in the Authorization header when making requests to other endpoints Tokens will be valid for 15 minutes before a new token must be obtained

Download OpenAPI description
billing-rest-authentication.json
billing-rest-authentication.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

authentication

The Elevate REST API uses JWT Bearer tokens for authentication

Operations

users

An identification used by a person with access to Elevate

Operations

user-roles

Permission groups that can be assigned to users

Operations

Get a list of available user roles

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
namestring(StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/user-roles?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

User role identifier

Example: 1
namestring[ 1 .. 50 ] charactersrequired

Role name

]
Response
application/json
[
  {
    "id": 1,
    "name": "string"
  }
]

app-clients

An identification used by a service that access Elevate APIs programmatically

Operations