OData Syntax & Query Parameter Options

You must follow OData syntax to format query parameters in the API. The syntax governs how URI statements are constructed, so it is essential to follow to initiate queries appropriately. The exact syntax and available functions within Aspire are consistent with OData V4.  

Use the described query options to retrieve and manipulate data returned in a request. All OData query options within the Aspire External API definition are prefixed with $. The query options that are described below can be used separately or combined. The same query option can not be repeated multiple times. 

Difference between RESTful OData and traditional REST API query parameters 

Aspire uses OData query parameters to retrieve, build, and manage data. While RESTful API using OData and REST APIs are very similar, there are some key differences to know so that you can be sure to execute requests that return or manipulate information as you intend. 

REST API query parameters can be unique and don't require adherence to a specific protocol, allowing variation in how query parameters can be formatted. OData, on the other hand, provides a standardized way of interacting with information across systems and requires following the syntax to create query parameters correctly. 

Syntax nuances 

In addition to the basic syntax rules described below, you will also want to keep the following information in mind. 

• When filtering a string data type, use single quotes to enclose the field value.
• If the data type is boolean, integer, decimal, or DateTime then it doesn't matter if you use single quotes.
• Use parentheses when grouping conditions within an expression. E.g., (Active eq true) and (BranchName eq West)
• OData is case-sensitive. 
• Whitespace within a value can impact your query. So, avoid using unneeded whitespace when assigning a value to a field or property. 
• The commonly followed query options are: 
  • $filter
  • $orderby
  • $top &$skip
  • $select
  • $expand

 OData query symbols

In constructing a request or viewing a request URL, special characters appear or are required depending on the action(s) taken. Below is a list of definitions for these special characters to better understand their purpose. 

Basic Query Structure 

You will find these elements within the OData query option structure. 

1.  The base URL (which is either going to be: https://cloudsandbox-api.youraspire.com or https://cloud-api.youraspire.com).
2. The resource being accessed. 
3. The query parameter.
4. The query syntax statement/clause.
   1. Some elements automatically populate or are predefined when using the API guide or the Swagger UI. Within the below examples provided for the query options, the options row displays how to format syntax statements within your queries. 

OData query options 

Query options are used with the idempotent GET method to create clauses based on your criteria. The query options discussed in this article are $filter,$orderby,$top,$skip, $limit,$select, and $pagenumber. 

Similarities between API OData and SQL query parameters options

If you are familiar with SQL, the following table will help you better understand OData query options. 

Field and property query options

• Field - attribute within an object on a database table. 
• Property - regulates how data stored in a field can be seen or changed.
• The fields and properties you can use in your query for a given endpoint are listed in the response schema $Array of object section. 

$filter,$select, and $orderby can be used with fields and properties. The field or property must be placed in the string beside the query option you select.

• $filter - restricts record information that is returned.
• $orderby - defines the order of returned records
• $select - only the selected attribute  is returned. 

$filter

• The $filter query option is probably the most commonly used. It offers the ability to refine the conditions that must be met in the data returned when building a request. You can use this query with any field for a given endpoint. 
• It can not be used on fields within a nested object or property  without the $expand query option. 
• Use comparison operators, logical operators, and built-in functions to create $filter clauses.  

Operator table 

The following provides an overview of the operators that can be used with the $filter query option. 

Comparison operators 

Below is a list of examples of the described operators. 

eq (equals) 

 Use to ensure that the data returned matches the value you selected to filter.

Example Response 

[
 {
  "ContactID": 22536,
  "CompanyID": 7885,
  "CompanyName": "ACompany, Inc.",
  "ContactTypeID": 1055,
  "ContactTypeName": "Customer",
  "OfficeAddress": {
   "AddressID": 34195,
   "AddressLine1": "Line 1",
   "AddressLine2": "Line 2",
   "City": "Saint Peters",
   "StateProvinceCode": "MO",
   "ZipCode": "63376",
   "CreatedByUserId": 3979,
   "CreatedOn": "2023-04-15T04:30:02.61Z",
   "LastModifiedByUserId": 3316,
   "LastModifiedOn": "2023-04-17T04:30:02.61Z"
  },
  "HomeAddress": {
   "AddressID": 44787,
   "AddressLine1": "Line 1",
   "AddressLine2": "Line 2",
   "City": "Saint Charles",
   "StateProvinceCode": null,
   "ZipCode": "71000",
   "CreatedByUserId": 3979,
   "CreatedOn": "2023-04-15T04:30:02.61Z",
   "LastModifiedByUserId": 3316,
   "LastModifiedOn": "2023-04-17T04:30:02.61Z"
  },
  "BranchID": 50,
  "BranchName": "St. Louis",
  "OwnerContactID": 22597,
  "OwnerContactName": "Bill Tower",
  "Salutation": null,
  "FirstName": "Bill",
  "LastName": "Tower",
  "ProspectRating": "2",
  "ProspectRatingName": "Warm",
  "Title": "Ownerr",
  "Email": "email@gmail.com",
  "MobilePhone": null,
  "OfficePhone": "(333) 333-3333",
  "HomePhone": "(333) 333-3333",
  "Fax": null,
  "Notes": "Testing Save in Mobile",
  "Active": true,
  "CreatedDateTime": null,
  "CreatedByUserID": null,
  "CreatedByUserName": null,
  "EmployeeNumber": "1164",
  "Website": null,
  "EmployeePin": "9219009",
  "AccountingSyncID": "1",
  "ExternalContactReference": "2",
  "TerminationDate": "2020-04-21T00:00:00Z",
  "HRNotes": null,
  "DefaultWorkersCompID": 13,
  "DefaultWorkersCompName": "Brick Laying",
  "DefaultWorkersCompStateProvinceCode": "AL",
  "UserID": 3197,
  "CrewSize": null,
  "PromptForCrewSize": false,
  "SubCrewLeaderContactID": null,
  "PayScheduleID": 38,
  "ModifiedDate": "2023-12-21T11:22:21.49Z",
  "ContactTags": []
 }

Code Sample 

curl --request GET \
--url ("https://cloud-api.youraspire.com/Contacts?%24filter=Active%20eq%20false")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBbmRIb3Vyc1wiOnRydWUsXCJDcmVhdGVFcXVpcG1lbnRJbnNwZWN0aW9uc1wiOnRydWUsXCJSZWNlaXZlUmVjZWlwdFwiOnRydWUsXCJNYW5hZ2VOb3RpZmljYXRpb25zU3lzdGVtXCI6dHJ1ZSxcIk1hbmFnZU5vdGlmaWNhdGlvbnNCcmFuY2hcIjp0cnVlLFwiUmVwb3J0V2ViRGVzaWduZXJcIjp0cnVlLFwiVmlld0ludmVudG9yeUxvY2F0aW9uc1wiOnRydWUsXCJFZGl0SW52ZW50b3J5TG9jYXRpb25zXCI6dHJ1ZSxcIlJvbGVQZXJtaXNzaW9uXCI6W10sXCJMb2NhbEJyYW5jaEFkbWluXCI6ZmFsc2UsXCJIYXNBbnlSZXBvcnRBY2Nlc3NcIjpmYWxzZX0iLCJBc3BpcmVTeXN0ZW1TZXR0aW5ncyI6IntcIkNvbXBhbnlOYW1lXCI6XCJJbmNyZWRpc2NhcGUgVUFUXCIsXCJFc3RpbWF0ZUxpY2Vuc2VcIjp0cnVlLFwiVGlja2V0TWFuYWdlbWVudExpY2Vuc2VcIjp0cnVlLFwiRXN0aW1hdGluZ1N0YWdpbmdcIjpmYWxzZSxcIkludm9pY2luZ0xpY2Vuc2VcIjp0cnVlLFwiQVJNYW5hZ2VtZW50TGljZW5zZVwiOnRydWUsXCJCaWxsaW5nRW1haWxGcm9tQWNjb3VudE93bmVyXCI6ZmFsc2UsXCJQYXljaGV4SW5jbHVkZURhdGVzXCI6dHJ1ZSxcIlJlcXVpcmVVbmlxdWVWZW5kb3JJbnZvaWNlTnVtYmVyXCI6ZmFsc2UsXCJSZXN0cmljdEVkaXRpbmdFbXBsb3llZXNcIjpmYWxzZSxcIkNyZWF0ZVByb3BlcnR5RnJvbUNvbnRhY3RcIjp0cnVlLFwiRW5hYmxlRWxlY3Ryb25pY1NpZ25hdHVyZXNcIjp0cnVlLFwiTWFzdGVyU3lzdGVtXCI6ZmFsc2UsXCJTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI6dHJ1ZSxcIlJvdW5kQ2xvY2tJbk91dFRpbWVzXCI6ZmFsc2UsXCJPTEFQUGl2b3RFbmFibGVkXCI6dHJ1ZSxcIkRpc2FibGVBdXRvbWF0aWNBcHByb3ZhbFwiOnRydWUsXCJEaXNhYmxlTW9iaWxlQ3Jld01hbmFnZW1lbnRcIjpmYWxzZSxcIkRpc2FibGVEZWxldGlvbk9mV29ya1RpY2tldHNcIjpmYWxzZSxcIkFsbG93U3ViVG9Mb2dpblwiOnRydWUsXCJIaWRlU2NoZWR1bGVQcm9ncmVzc0JhclwiOmZhbHNlLFwiV2Fybk9uRWFybHlMdW5jaENsb2NraW5cIjoyLFwiQ2FsaWZvcm5pYVRpbWVQcm9tcHRc19UaW1lQWNjZXB0YW5jZVwiOmZhbHNlLFwiRW50ZXJwcmlzZUFkbWluVHlwZVwiOjB9IiwiRm9yYmlkZGVuIjoiIiwibmJmIjoxNzA0Njg0Njc2LCJleHAiOjE3MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header
("accept","application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

 ne (not equal) 

 Use to ensure that the data returned does not match the value you selected to filter.

Example Response 

[
 {
  "OpportunityID": 26382,
  "PropertyID": 34246,
  "OpportunityStatusID": 122,
  "OpportunityStatusName": "1.Won",
  "SalesRepContactID": 22596,
  "SalesRepContactName": "Joe Smith",
  "OperationsManagerContactID": null,
  "OperationsManagerContactName": null,
  "DivisionID": 90,
  "DivisionName": "Enhancement",
  "BranchID": 50,
  "BranchName": "St. Louis",
  "SalesTypeID": 29,
  "SalesTypeName": "New Sale",
  "TemplateOpportunityID": null,
  "LeadSourceID": null,
  "LeadSourceName": null,
  "MasterOpportunityID": null,
  "BillingAddressID": 39552,
  "BillingAddressLine1": "6744 S Maple Court",
  "BillingAddressLine2": null,
  "BillingAddressCity": "Chancy",
  "BillingAddressStateProvinceCode": "MO",
  "BillingAddressZipCode": "63350",
  "OpportunityType": "Work Order",
  "MasterSequenceNum": null,
  "OpportunityName": "Have Rambo Sign it",
  "ProposalDescription1": null,
  "StartDate": "2024-01-01T00:00:00Z",
  "EndDate": "2024-01-31T00:00:00Z",
  "BidDueDate": null,
  "CreatedDateTime": "2019-02-01T20:36:00.787Z",
  "ApprovedDate": "2024-01-03T12:07:46.903Z",
  "ProposedDate": "2024-01-03T12:07:59.883Z",
  "WonDate": "2024-01-03T12:08:55.357Z",
  "LostDate": null,
  "Probability": 100,
  "AnticipatedCloseDate": null,
  "InvoiceType": "Fixed Price on Completion",
  "CustomerContractNum": null,
  "CustomerPONum": null,
  "BudgetedDollars": 0,
  "EstimatedDollars": 286.74,
  "StateTaxPercent": 5.5,
  "FederalTaxPercent": 0,
  "CreatedByUserID": 3317,
  "CreatedByUserName": "Joe Smith",
  "ApprovedUserID": 3643,
  "ApprovedUserName": Judge Judy"

Code Sample 

curl --request GET \
--url ("https://cloud-api.youraspire.com/Contacts?%24filter=Email%20ne%20'user%40email.com'")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XnRpZXNcIjpmYWxzZSxsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGFJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBbmRIb3Vyc1wiOnRydWUsXCJDcmVhdGVFcXVpcG1lbnRJbnNwZWN0aW9uc1wiOnRydWUsXCJSZWNlaXZlUmVjZWlwdFwiOnRydWUsXCJNYW5hZ2VOb3RpZmljYXRpb25zU3lzdGVtXCI6dHJ1ZSxcIk1hbmFnZU5vdGlmaWNhdGlvbnNCcmFuY2hcIjp0cnVlLFwiUmVwb3J0V2ViRGVzaWduZXJcIjp0cnVlLFwiVmlld0ludmVudG9yeUxvY2F0aW9uc1wiOnRydWUsXCJFZGl0SW52ZW50b3J5TG9jYXRpb25zXCI6dHJ1ZSxcIlJvbGVQZXJtaXNzaW9uXCI6W10sXCJMb2NhbEJyYW5jaEFkbWluXCI6ZmFsc2UsXCJIYXNBbnlSZXBvcnRBY2Nlc3NcIjpmYWxzZX0iLCJBc3BpcmVTeXN0ZW1TZXR0aW5ncyI6IntcIkNvbXBhbnlOYW1lXCI6XCJJbmNyZWRpc2NhcGUgVUFUXCIsXCJFc3RpbWF0ZUxpY2Vuc2VcIjp0cnVlLFwiVGlja2V0TWFuYWdlbWVudExpY2Vuc2VcIjp0cnVlLFwiRXN0aW1hdGluZ1N0YWdpbmdcIjpmYWxzZSxcIkludm9pY2luZ0xpY2Vuc2VcIjp0cnVlLFwiQVJNYW5hZ2VtZW50TGljZW5zZVwiOnRydWUsXCJCaWxsaW5nRW1haWxGcm9tQWNjb3VudE93bmVyXCI6ZmFsc2UsXCJQYXljaGV4SW5jbHVkZURhdGVzXCI6dHJ1ZSxcIlJlcXVpcmVVbmlxdWVWZW5kb3JJbnZvaWNlTnVtYmVyXCI6ZmFsc2UsXCJSZXN0cmljdEVkaXRpbmdFbXBsb3llZXNcIjpmYWxzZSxcIkNyZWF0ZVByb3BlcnR5RnJvbUNvbnRhY3RcIjp0cnVlLFwiRW5hYmxlRWxlY3Ryb25pY1NpZ25hdHVyZXNcIjp0cnVlLFwiTWFzdGVyU3lzdGVtXCI6ZmFsc2UsXCJTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI6dHJ1ZSxcIlJvdW5kQ2xvY2tJbk91dFRpbWVzXCI6ZmFsc2UsXCJPTEFQUGl2b3RFbmFibGVkXCI6dHJ1ZSxcIkRpc2FibGVBdXRvbWF0aWNBcHByb3ZhbFwiOnRydWUsXCJEaXNhYmxlTW9iaWxlQ3Jld01hbmFnZW1lbnRcIjpmYWxzZSxcIkRpc2FibGVEZWxldGlvbk9mV29ya1RpY2tldHNcIjpmYWxzZSxcIkFsbG93U3ViVG9Mb2dpblwiOnRydWUsXCJIaWRlU2NoZWR1bGVQcm9ncmVzc0JhclwiOmZhbHNlLFwiV2Fybk9uRWFybHlMdW5jaENsb2NraW5cIjoyLFwiQ2FsaWZvcm5pYVRpbWVQcm9tcHRzXCI6ZmFsc2UsXCJJbnZvaWNpbmdBc3Npc3RhbnRSZXF1aXJlQmlsbGluZ0NvbXBhbnlcIjpmYWxzZSxcIkVuZm9yY2VCcmFuY2hBZG1pbkFkbWluaXN0cmF0aW9uU2VjdXJpdHlcIjp0cnVlLFwiT1RDYWxjdWxhdGlvblwiOlwiT3ZlcnJpZGUgUGF5Y29kZVwiLFwiRXF1aXBtZW50UmVhZGluZ0Nsb2NrT3V0UHJvbXB0XCI6XCJFbmQgb2YgRGF5XCIsXCJTaG93TmV0R3Jvc3NNYXJnaW5PbkVzdGltYXRpbmdTY3JlZW5cIjp0cnVlLFwiU2hvd09ubHlHcm9zc01hcmdpbm9uRXN0aW1hdGluZ1NjcmVlblwiOmZhbHNlLFwiQ3JlYXRlRXF1aXBtZW50UmVhZGluZ3NcIjp0cnVlLFwiSW5jbHVkZURyaXZlVGltZVdoZW5Mb2dnaW5nRXF1aXBtZW50Q3Jld01vYmlsZVwiOnRydWUsXCJFbmFibGVOZWdhdGl2ZUNoYW5nZU9yZGVyc1wiOnRydWUsXCJFbmFibGVDdXN0b21lclBvcnRhbFwiOnRydWUsXCJEZWZhdWx0R0VPUGVyaW1ldGVyXCI6NTAwLjAsXCJFbmFibGVBc3BpcmVHUFNJbnRlZ3JhdGlvblwiOnRydWUsXCJFbmFibGVFcXVpcG1lbnRNb2R1bGVBZGRPblwiOnRydWUsXCJHUFNJbnRlZ3JhdGlvblByb3ZpZGVyXCI6MyxcIkVuYWJsZUVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFbmFibGVTaXRlT25lXCI6ZmFsc2UsXCJCcmVha1RpbWVcIjowLjUsXCJQYXljaGV4RXhwb3J0Rm9ybWF0XCI6XCJEZWZhdWx0IENTVlwiLFwiRW5hYmxlUGFydGlhbFRpbWVPblN1YlBvcnRhbFwiOnRydWUsXCJFbmFibGVQYXJ0aWFsVGltZU9uQ3Jld01vYmlsZVwiOnRydWUsXCJFbmFibGVMYW5kc2NhcGVIdWJJbnRlZ3JhdGlvblwiOnRydWUsXCJEaXNwbGF5VGF4T25Fc3RpbWF0ZVwiOnRydWUsXCJMaW5rU2NoZWR1bGVvZlZhbHVldG9TZXJ2aWNlQnlEZWZhdWx0XCI6ZmFsc2UsXCJFbmFibGVXZWF0aGVybWF0aWNJbnRlZ3JhdGlvblwiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFNlbGVjdFRvcE51bWJlclwiOjUwMDAsXCJFbmFibGVPdmVyVW5kZXJBZGp1c3RtZW50c1wiOnRydWUsXCJEZWZhdWx0RGl2aXNpb25JREZvcldvcmtPcmRlcnNcIjowLFwiRGVmYXVsdEZvbnRcIjpcIlZlcmRhbmEsc2Fucy1zZXJpZlwiLFwiRGVmYXVsdEZvbnRTaXplXCI6XCIxNC4wMFwiLFwiQ3Jld0xlYWRlclJvbGVJRFwiOjEyMDIsXCJSZXF1aXJlTm9PcGVuSW52b2ljZXNDaGVja1wiOnRydWUsXCJQcm9kdWN0VGllclwiOjAsXCJDYW5BY2Nlc3NBUElzXCI6ZmFsc2UsXCJIYXNGYWNpYWxSZWNcIjpmYWxzZSxcIkVuYWJsZVRha2VvZmZJbnRlZ3JhdGlvblwiOnRydWUsXCJUYWtlb2ZmSW50ZWdyYXRpb25UeXBlXCI6NyxcIkRlZmF1bHRQcm9wZXJ0eVRha2VvZmZQcm92aWRlclwiOjQsXCJEZWZhdWx0RXN0aW1hdGVUYWtlb2ZmUHJvdmlkZXJcIjo0LFwiRW5hYmxlV2ViUmVwb3J0RGVzaWduZXJcIjpmYWxzZSxcIkF6dWdhQ3VzdG9tZXJJRFwiOjEwNTksXCJFbmFibGVDcmV3TWVtYmVyQ2xvY2tJbldpdGhvdXRDcmV3TGVhZGVyXCI6ZmFsc2UsXCJFbmFibGVFT01SZXBvcnRcIjpmYWxzZSxcIlVzZU9wcG9ydHVuaXR5SXRlbURpc3BsYXlOYW1lT25JbnZvaWNlXCI6dHJ1ZSxcIkVuYWJsZVZpc2l0Q2hlY2tsaXN0c1wiOnRydWUsXCJUaW1lWm9uZVwiOlwiQW1lcmljYS9DaGljYWdvXCIsXCJGaXJzdERheU9mV2Vla1wiOlwiTW9uZGF5XCIsXCJJbm92YUVuYWJsZWRcIjp0cnVlLFwiUFRPVmlzaWJsZVwiOnRydWUsXCJNYXJrZXRpbmdQcm9JbnRlZ3JhdGlvblwiOmZhbHNlLFwiTWFya2V0aW5nUHJvVmVyc2lvblwiOm51bGwsXCJFbmFibGVBdXRvVGltZUFjY2VwdGFuY2VDb25maWdcIjpmYWxzZSxcIkVuYWJsZUF1dG9UaW1lQWNjZXB0YW5jZVwiOmZhbHNlLFwiRW50ZXJwcmlzZUFkbWluVHlwZVwiOjB9IiwiRm9yYmlkZGVuIjoiIiwibmJmIjoxNzA0Njg0Njc2LCJleHAiOjE3MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

gt (greater than) 

 Use to ensure the data returned is greater than the value you selected to filter.

Example Response 

[
 {
  "OpportunityID": 45237,
  "PropertyID": 34481,
  "OpportunityStatusID": 122,
  "OpportunityStatusName": "1.Won",
  "SalesRepContactID": 25162,
  "SalesRepContactName": "A Name",
  "OperationsManagerContactID": 24843,
  "OperationsManagerContactName": "A Route Manager",
  "DivisionID": 90,
  "DivisionName": "Enhancement",
  "BranchID": 176,
  "BranchName": "Illinois",
  "SalesTypeID": 29,
  "SalesTypeName": "New Sale",
  "TemplateOpportunityID": null,
  "LeadSourceID": null,
  "LeadSourceName": null,
  "MasterOpportunityID": null,
  "BillingAddressID": 149468,
  "BillingAddressLine1": "4900 HOMER DR Denali AK 99503-7531 USA",
  "BillingAddressLine2": "1920 E BLVD ANCHORAGE AK 99507-2661 USA",
  "BillingAddressCity": "Anchorage",
  "BillingAddressStateProvinceCode": "AL",
  "BillingAddressZipCode": "99540",
  "OpportunityType": "Contract",
  "MasterSequenceNum": null,
  "OpportunityName": "AC-18291",
  "ProposalDescription1": null,
  "StartDate": "2023-12-13T00:00:00Z",
  "EndDate": "2023-12-13T00:00:00Z",
  "BidDueDate": null,
  "CreatedDateTime": "2023-12-13T21:10:33.063Z",
  "ApprovedDate": "2023-12-13T21:12:46.687Z",
  "ProposedDate": "2023-12-13T21:14:30.55Z",
  "WonDate": "2023-12-13T21:14:30.55Z",
  "LostDate": null,
  "Probability": 100,
  "AnticipatedCloseDate": "2024-12-13T00:00:00Z",
  "InvoiceType": "Fixed Payment",
  "CustomerContractNum": null,
  "CustomerPONum": null,
  "BudgetedDollars": 0,
  "EstimatedDollars": 3120,
  "StateTaxPercent": 5.5,
  "FederalTaxPercent": 0,
  "CreatedByUserID": 3638,
  "CreatedByUserName": "A Name",
  "ApprovedUserID": 3638,
  "ApprovedUserName": "A Name",
  "ProposedUserID": 3638,
  "ProposedUserName": "A Name",
  "ClosedUserID": 3638,
  "ClosedUserName": "A Name",
  "CompetitorID": null,
  "CompetitorName": null,
  "LostReason": null,
  "BillingContactID": 42937,
  "BillingContactName": "Judge Judy",
  "ProposalDescription2": null,
  "OpportunityNumber": 20268,
  "EstimatedCostDollars": 3120,
  "EstimatedOverheadDollars": 0,
  "EstimatedBreakEvenDollars": 3120,
  "EstimatedNetProfitPercent": 0,
  "EstimatedNetProfitDollars": 0,
  "EstimatedGrossMarginPercent": 0,
  "EstimatedGrossMarginDollars": 0,
  "EstimatedLaborHours": 104,
  "EstimatedLaborCostPerHour": 30,
  "EstimatedRealizeRate": 30,
  "EstimatedEquipmentCost": 0,
  "EstimatedLaborCost": 3120,
  "EstimatedMaterialCost": 0,
  "EstimatedOtherCost": 0,
  "EstimatedSubCost": 0,
  "ActualCostDollars": 0,
  "ActualGrossMarginPercent": 0,
  "ActualGrossMarginDollars": 0,
  "ActualLaborHours": 0,
  "ActualLaborCostPerHour": 0,
  "ActualEarnedRevenue": 0,
  "InvoiceNote": null,
  "PercentComplete": 0,
  "RenewalDate": "2023-12-13T00:00:00Z",
  "ModifiedByUserID": 3638,
  "ModifiedByUserName": "QA1 QA",
  "ModifiedDate": "2023-12-13T21:59:24.627Z",
  "OverridePaymentTermsID": null,
  "OverridePaymentTerms": null,
  "RetainagePercent": null,
  "EstimatorNotes": null,
  "ElectronicPaymentsOverrideConvenienceFee": null,
  "OpportunityCanceledReasonID": 11,
  "OpportunityCanceledReason": "IB Canceled Opportunity Reason",
  "RetainageMaturityDate": null,
  "DistrictName": "District West13",
  "JobStatusName": "Canceled",
  "RegionName": "Southwest Region",
  "PaymentTermsID": 40,
  "BillingCompanyID": 7713,
  "BillingCompanyName": "Aspire",
  "BranchCode": "dasdas",
  "PropertyName": "#123 Costco",
  "DivisionCode": "EN",
  "TaxablePercent": 100,
  "TaxableAmount": 3120,
  "TMPerServiceTaxableAmount": 0,
  "ActualCostSub": 0,
  "ActualCostMaterial": 0,
  "ActualCostLabor": 0,
  "CompleteDate": null,
  "OpportunityRevisions": [],
  "OpportunityBillings": [
   {
    "OpportunityBillingID": 46010,
    "OpportunityBillingRefID": null,
    "BillMonth": 12,
    "InvoiceDescription": null,
    "InvoiceTriggerPercent": null,
    "InvoiceAmount": 3120,
    "SortOrder": 1,
    "Active": true,
    "OpportunityRevisionID": null
   }
  ],
  "ScheduleOfValueGroups": []
 },
]

Code Sample

curl --request GET \
--url ("https://cloud-api.youraspire.com//Opportunities?%24filter=AnticipatedCloseDate%20gt%202023-12-15")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWHlcIjp0sc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBbmRIb3Vyc1wiOnRydWUsXCJDcmVhdGVFcXVpcG1lbnRJbnNwZWN0aW9uc1wiOnRydWUsXCJSZWNlaXZlUmVjZWlwdFwiOnRydWUsXCJNYW5hZ2VOb3RpZmljYXRpb25zU3lzdGVtXCI6dHJ1ZSxcIk1hbmFnZU5vdGlmaWNhdGlvbnNCcmFuY2hcIjp0cnVlLFwiUmVwb3J0V2ViRGVzaWduZXJcIjp0cnVlLFwiVmlld0ludmVudG9yeUxvY2F0aW9uc1wiOnRydWUsXCJFZGl0SW52ZW50b3J5TG9jYXRpb25zXCI6dHJ1ZSxcIlJvbGVQZXJtaXNzaW9uXCI6W10sXCJMb2NhbEJyYW5jaEFkbWluXCI6ZmFsc2UsXCJIYXNBbnlSZXBvcnRBY2Nlc3NcIjpmYWxzZX0iLCJBc3BpcmVTeXN0ZW1TZXR0aW5ncyI6IntcIkNvbXBhbnlOYW1lXCI6XCJJbmNyZWRpc2NhcGUgVUFUXCIsXCJFc3RpbWF0ZUxpY2Vuc2VcIjp0cnVlLFwiVGlja2V0TWFuYWdlbWVudExpY2Vuc2VcIjp0cnVlLFwiRXN0aW1hdGluZ1N0YWdpbmdcIjpmYWxzZSxcIkludm9pY2luZ0xpY2Vuc2VcIjp0cnVlLFwiQVJNYW5hZ2VtZW50TGljZW5zZVwiOnRydWUsXCJCaWxsaW5nRW1haWxGcm9tQWNjb3VudE93bmVyXCI6ZmFsc2UsXCJQYXljaGV4SW5jbHVkZURhdGVzXCI6dHJ1ZSxcIlJlcXVpcmVVbmlxdWVWZW5kb3JJbnZvaWNlTnVtYmVyXCI6ZmFsc2UsXCJSZXN0cmljdEVkaXRpbmdFbXBsb3llZXNcIjpmYWxzZSxcIkNyZWF0ZVByb3BlcnR5RnJvbUNvbnRhY3RcIjp0cnVlLFwiRW5hYmxlRWxlY3Ryb25pY1NpZ25hdHVyZXNcIjp0cnVlLFwiTWFzdGVyU3lzdGVtXCI6ZmFsc2UsXCJTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI6dHJ1ZSxcIlJvdW5kQ2xvY2tJbk91dFRpbWVzXCI6ZmFsc2UsXCJPTEFQUGl2b3RFbmFibGVkXCI6dHJ1ZSxcIkRpc2FibGVBdXRvbWF0aWNBcHByb3ZhbFwiOnRydWUsXCJEaXNhYmxlTW9iaWxlQ3Jld01hbmFnZW1lbnRcIjpmYWxzZSxcIkRpc2FibGVEZWxldGlvbk9mV29ya1RpY2tldHNcIjpmYWxzZSxcIkFsbG93U3ViVG9Mb2dpblwiOnRydWUsXCJIaWRlU2NoZWR1bGVQcm9ncmVzc0JhclwiOmZhbHNlLFwiV2Fybk9uRWFybHlMdW5jaENsb2NraW5cIjoyLFwiQ2FsaWZvcm5pYVRpbWVQcm9tcHRzXCI6ZmFsc2UsXCJJbnZvaWNpbmdBc3Npc3RhbnRSZXF1aXJlQmlsbGluZ0NvbXBhbnlcIjpmYWxzZSxcIkVuZm9yY2VCcmFuY2hBZG1pbkFkbWluaXN0cmF0aW9uU2VjdXJpdHlcIjp0cnVlLFwiT1RDYWxjdWxhdGlvblwiOlwiT3ZlcnJpZGUgUGF5Y29kZVwiLFwiRXF1aXBtZW50UmVhZGluZ0Nsb2NrT3V0UHJvbXB0XCI6XCJFbmQgb2YgRGF5XCIsXCJTaG93TmV0R3Jvc3NNYXJnaW5PbkVzdGltYXRpbmdTY3JlZW5cIjp0cnVlLFwiU2hvd09ubHlHcm9zc01hcmdpbm9uRXN0aW1hdGluZ1NjcmVlblwiOmZhbHNlLFwiQ3JlYXRlRXF1aXBtZW50UmVhZGluZ3NcIjp0cnVlLFwiSW5jbHVkZURyaXZlVGltZVdoZW5Mb2dnaW5nRXF1aXBtZW50Q3Jld01vYmlsZVwiOnRydWUsXCJFbmFibGVOZWdhdGl2ZUNoYW5nZU9yZGVyc1wiOnRydWUsXCJFbmFibGVDdXN0b21lclBvcnRhbFwiOnRydWUsXCJEZWZhdWx0R0VPUGVyaW1ldGVyXCI6NTAwLjAsXCJFbmFibGVBc3BpcmVHUFNJbnRlZ3JhdGlvblwiOnRydWUsXCJFbmFibGVFcXVpcG1lbnRNb2R1bGVBZGRPblwiOnRydWUsXCJHUFNJbnRlZ3JhdGlvblByb3ZpZGVyXCI6MyxcIkVuYWJsZUVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFbmFibGVTaXRlT25lXCI6ZmFsc2UsXCJCcmVha1RpbWVcIjowLjUsXCJQYXljaGV4RXhwb3J0Rm9ybWF0XCI6XCJEZWZhdWx0IENTVlwiLFwiRW5hYmxlUGFydGlhbFRpbWVPblN1YlBvcnRhbFwiOnRydWUsXCJFbmFibGVQYXJ0aWFsVGltZU9uQ3Jld01vYmlsZVwiOnRydWUsXCJFbmFibGVMYW5kc2NhcGVIdWJJbnRlZ3JhdGlvblwiOnRydWUsXCJEaXNwbGF5VGF4T25Fc3RpbWF0ZVwiOnRydWUsXCJMaW5rU2NoZWR1bGVvZlZhbHVldG9TZXJ2aWNlQnlEZWZhdWx0XCI6ZmFsc2UsXCJFbmFibGVXZWF0aGVZXF1aXJlTm9PcGVuSW52b2ljZXNDaGVja1wiOnRydWUsXCJQcm9kdWN0VGllclwiOjAsXCJDYW5BY2Nlc3NBUElzXCI6ZmFsc2UsXCJIYXNGYWNpYWxSZWNcIjpmYWxzZSxcIkVuYWJsZVRha2VvZmZJbnRlZ3JhdGlvblwiOnRydWUsXCJUYWtlb2ZmSW50ZWdyYXRpb25UeXBlXCI6NyxcIkRlZmF1bHRQcm9wZXJ0eVRha2VvZmZQcm92aWRlclwiOjQsXCJEZWZhdWx0RXN0aW1hdGVUYWtlb2ZmUHJvdmlkZXJcIjo0LFwiRW5hYmxlV2ViUmVwb3J0RGVzaWduZXJcIjpmYWxzZSxcIkF6dWdhQ3VzdG9tZXJJRFwiOjEwNTksXCJFbmFibGVDcmV3TWVtYmVyQ2xvY2tJbldpdGhvdXRDcmV3TGVhZGVyXCI6ZmFsc2UsXCJFbmFibGVFT01SZXBvcnRcIjpmYWxzZSxcIlVzZU9wcG9ydHVuaXR5SXRlbURpc3BsYXlOYW1lT25JbnZvaWNlXCI6dHJ1ZSxcIkVuYWJsZVZpc2l0Q2hlY2tsaXN0c1wiOnRydWUsXCJUaW1lWm9uZVwiOlwiQW1lcmljYS9DaGljYWdvXCIsXCJGaXJzdERheU9mV2Vla1wiOlwiTW9uZGF5XCIsXCJJbm92YUVuYWJsZWRcIjp0cnVlLFwiUFRPVmlzaWJsZVwiOnRydWUsXCJNYXJrZXRpbmdQcm9JbnRlZ3JhdGlvblwiOmZhbHNlLFwiTWFya2V0aW5nUHJvVmVyc2lvblwiOm5WluVHlwZVwiOjB9IiwiRm9yYmlkZGVuIjoiIiwibmJmIjoxNzA0Njg0Njc2LCJleHAiOjE3MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

ge (greater than or equal to) 

Value is greater than or equal to the value you selected to filter.

Example Response 

[
 {
  "OpportunityID": 26382,
  "PropertyID": 34246,
  "OpportunityStatusID": 122,
  "OpportunityStatusName": "1.Won",
  "SalesRepContactID": 22596,
  "SalesRepContactName": "Joe Barry",
  "OperationsManagerContactID": null,
  "OperationsManagerContactName": null,
  "DivisionID": 90,
  "DivisionName": "Enhancement",
  "BranchID": 50,
  "BranchName": "St. Louis",
  "SalesTypeID": 29,
  "SalesTypeName": "New Sale",
  "TemplateOpportunityID": null,
  "LeadSourceID": null,
  "LeadSourceName": null,
  "MasterOpportunityID": null,
  "BillingAddressID": 39552,
  "BillingAddressLine1": "6744 S Maple Court",
  "BillingAddressLine2": null,
  "BillingAddressCity": "Chancy",
  "BillingAddressStateProvinceCode": "MO",
  "BillingAddressZipCode": "63351",
  "OpportunityType": "Work Order",
  "MasterSequenceNum": null,
  "OpportunityName": "An Opportunity",
  "ProposalDescription1": null,
  "StartDate": "2024-01-01T00:00:00Z",
  "EndDate": "2024-01-31T00:00:00Z",
  "BidDueDate": null,
  "CreatedDateTime": "2019-02-01T20:36:00.787Z",
  "ApprovedDate": "2024-01-03T12:07:46.903Z",
  "ProposedDate": "2024-01-03T12:07:59.883Z",
  "WonDate": "2024-01-03T12:08:55.357Z",
  "LostDate": null,
  "Probability": 100,
  "AnticipatedCloseDate": null,
  "InvoiceType": "Fixed Price on Completion",
  "CustomerContractNum": null,
  "CustomerPONum": null,
  "BudgetedDollars": 0,
  "EstimatedDollars": 286.74,
  "StateTaxPercent": 5.5,
  "FederalTaxPercent": 0,
  "CreatedByUserID": 3317,
  "CreatedByUserName": "Joe Barry",
  "ApprovedUserID": 3643,
  "ApprovedUserName": "A Name",
  "ProposedUserID": 3643,
  "ProposedUserName": A Name",
}
]

Code Sample 

curl --request GET \
--url ("https://cloud-api.youraspire.com/Opportunities?%24filter=WonDate%20ge%202023-12-26")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBbmRIb3Vyc1wiOnRydWUsXCJDcmVhdGVFcXVpcG1lbnRJbnNwZWN0aW9uc1wiOnRydWUsXCJSZWNlaXZlUmVjZWlwdFwiOnRydWUsXCJNYW5hZ2VOb3RpZmljYXRpb25zU3lzdGVtXCI6dHJ1ZSxcIk1hbmFnZU5vdGlmaWNhdGlvbnNCcmFuY2hcIjp0cnVlLFwiUmVwb3J0V2ViRGVzaWduZXJcIjp0cnVlLFwiVmlld0ludmVudG9yeUxvY2F0aW9uc1wiOnRydWUsXCJFZGl0SW52ZW50b3J5TG9jYXRpb25zXCI6dHJ1ZSxcIlJvZmFsc2UsXCJFbmFibGVFT01SZXBvcnRcIjpmYWxzZSxcIlVzZU9wcG9ydHVuaXR5SXRlbURpc3BsYXlOYW1lT25JbnZvaWNlXCI6dHJ1ZSxcIkVuYWJsZVZpc2l0Q2hlY2tsaXN0c1wiOnRydWUsXCJUaW1lWm9uZVwiOlwiQW1lcmljYS9DaGljYWdvXCIsXCJGaXJzdERheU9mV2Vla1wiOlwiTW9uZGF5XCIsXCJJbm92YUVuYWJsZWRcIjp0cnVlLFwiUFRPVmlzaWJsZVwiOnRydWUsXCJNYXJrZXRpbmdQcm9JbnRlZ3JhdGlvblwiOmZhbHNlLNzA0Njg0Njc2LCJleHAiOjE3MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

lt (less than) 

The value is less than.

Example Response

[
 {
  "BankDepositID": 2086,
  "BranchID": null,
  "BranchName": null,
  "DepositDate": "2017-04-28T00:00:00Z",
  "DepositAmount": 287.3,
  "DepositStatus": "Sent",
  "CreatedDateTime": "2017-04-28T12:53:37.53Z",
  "CreatedByUserID": 3317,
  "CreatedByUserName": "Joe Barry",
  "DateSentToAccounting": "2019-02-04T17:08:19.57Z",
  "SentToAccountingUserID": 3317,
  "SentToAccountingUserName": "Joe Barry",
  "AccountingMessage": null,
  "ResetToNewDate": null,
  "ResetToNewUserID": null,
  "ResetToNewUserName": null
 }
]

Code Sample

curl --request GET \
--url ("https:///cloud-api.youraspire.com/BankDeposits?%24filter=DepositAmount%20lt%201000.00")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBZvaWNlTnVtYmVyXCI6ZmFsc2UsXCJSZXN0cmljdEVkaXRpbmdFbXBsb3llZXNcIjpmYWxzZSxcIkNyZWF0ZVByb3BlcnR5RnJvbUNvbnRhY3RcIjp0cnVlLFwiRW5hYmxlRWxlY3Ryb25pY1NpZ25hdHVyZXNcIjp0cnVlLFwiTWFzdGVyU3lzdGVtXCI6ZmFsc2UsXCJTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI63MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

le 

Use to get a value that is less than or equal. 

Example Response

[
 {
  "ClockTimeID": 17662,
  "ContactID": 22609,
  "ContactName": "Jimmy  Labor",
  "ClockStart": "2016-10-10T08:00:00Z",
  "ClockEnd": "2016-10-10T16:30:00Z",
  "AcceptedDateTime": "2016-11-01T18:28:59.557Z",
  "AcceptedUserID": 3197,
  "AcceptedUserName": "A User Name",
  "BreakTime": 0.5,
  "AcceptedShortLunch": false,
  "UsedBreaks": false,
  "PreventedFromUsingBreaks": false,
  "GEOLocationStartLatitude": null,
  "GEOLocationStartLongitude": null,
  "GEOLocationEndLatitude": null,
  "GEOLocationEndLongitude": null
 }
]

Code Sample 

curl --request GET \
--url ("https://acloud-api.youraspire.com/ClockTimes?%24filter=BreakTime%20le%201%20")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUGRGl2aXNpb25JREZvcld25UeXBlXCI6NyxcIkRlZmF1bHRQcm9wZXJ0eVRha2VvZmZQcm92aWRlclwiOjQsXCJEZWZhdWx0RXN0aW1hdGVUYWtlb2ZmUHJvdmlkZXJcIjo0LFwiRW5hYmxlV2ViUmVwb3J0RGVzaWduZXJcIjpmYWxzZSxcIkF6dWdhQ3VzdG9tZXJJRFwiOjEwNTksXCJFbmFibGVDcmV3TWVtYmVyQ2xvY2tJbldpdGhvdXRDcmV3TGVhZGVyXCI6ZmFsc2UsXCJFbmFibGVFT01SZXBvcnRcIjpmYWxzZSxcIlVzZU9wcG9ydHVuaXR5SXRlbURpc3BsYXlOYW1lT25JbnZvaWNlXCI6dHJ1ZSxcIkVuYWJsZVZpc2l0Q2hlY2tsaXN0c1wiOnRydWUsXCJUaW1lWm9uZVwiOlwiQW1lcmljYS9DaGljYWdvXCIsXCJGaXJzdERheU9mV2Vla1wiOlwiTW9uZGF5XCIsXCJJbm92YUVuYWJsZWRcIjp0cnVlLFwiUFRPVmlzaWJsZVwiOnRydWUsXCJNYXJrZXRpbmdQcm9JbnRlZ3JhdGlvblwiOmZhbHNlLFwiTWFya2V0aW5nUHJvVmVyc2lvblwiOm51bGwsXCJFbNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

Logical operators 

Use logical operations to combine conditions. 

and  

combine multiple conditions; all conditions must be true.

or  

use to combine multiple conditions and require that at least one condition is true. 

Example Response

[
 {
  "ContactID": 1,
  "CompanyID": 1,
  "CompanyName": "string",
  "ContactTypeID": 1,
  "ContactTypeName": "string",
  "OfficeAddress": {
   "AddressID": 1,
   "AddressLine1": "string",
   "AddressLine2": "string",
   "City": "string",
   "StateProvinceCode": "string",
   "ZipCode": "string",
   "CreatedByUserId": 1,
   "CreatedOn": "string",
   "LastModifiedByUserId": 1,
   "LastModifiedOn": "string"
  },
  "HomeAddress": {
   "AddressID": 1,
   "AddressLine1": "string",
   "AddressLine2": "string",
   "City": "string",
   "StateProvinceCode": "string",
   "ZipCode": "string",
   "CreatedByUserId": 1,
   "CreatedOn": "string",
   "LastModifiedByUserId": 1,
   "LastModifiedOn": "string"
  },
  "BranchID": 1,
  "BranchName": "string",
  "OwnerContactID": 1,
  "OwnerContactName": "string",
  "Salutation": "string",
  "FirstName": "string",
  "LastName": "string",
  "ProspectRating": "string",
  "ProspectRatingName": "string",
  "Title": "string",
  "Email": "string",
  "MobilePhone": "string",
  "OfficePhone": "string",
  "HomePhone": "string",
  "Fax": "string",
  "Notes": "string",
  "Active": true,
  "CreatedDateTime": "string",
  "CreatedByUserID": 1,
  "CreatedByUserName": "string",
  "EmployeeNumber": "string",
  "Website": "string",
  "EmployeePin": "string",
  "AccountingSyncID": "string",
  "ExternalContactReference": "string",
  "TerminationDate": "string",
  "HRNotes": "string",
  "DefaultWorkersCompID": 1,
  "DefaultWorkersCompName": "string",
  "DefaultWorkersCompStateProvinceCode": "string",
  "UserID": 1,
  "CrewSize": 1,
  "PromptForCrewSize": true,
  "SubCrewLeaderContactID": 1,
  "PayScheduleID": 1,
  "ModifiedDate": "string",
  "ContactTags": [
   {
    "ContactTagID": 1,
    "TagID": 1,
    "TagName": "string"
   }
  ]
 }
]

Code Sample

curl --request GET \
--url ("https://cloud-api.youraspire.com/Contacts?%24filter=(Active%20eq%20true%20and%20CompanyID%20ne%201000)%20or%20Email%20eq%20'user%40email.com'")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjpXCI6XCJFbmQgb2YgRGF5XCIsXCJTaG93TmV0R3Jvc3NNYXJnaW5PbkVzdGltYXRpbmdTY3JlZW5cIjp0cnVlLFwiJmIjoxNzA0Njg0Njc2LCJleHAiOjE3MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

Built-in functions

Built-in functions are similar to operators but allow you to execute specific operations on data values outside of comparisons. They can perform specific operations on data values, string manipulations, date operations, etc. They can be used with string and DateTime data types. When using built-in functions with string data types, you must enclose properties/fields with parentheses. 

Common built-in functions: 

Use with string data type: 

• startswith -  returns values when the first characters are defined within the string or collection is true. 
• endswith -  returns values when the last characters defined in the string or collection are true. This can only be used with strings. 
• contains - returns value when defined entity within string or collection is true. 
• lengths -  returns value when the number of characters defined is true. 
• toupper - converts string value to uppercase. 
• tolower - converts string value to lowercase. 

Example Response 

[
 {
  "BranchID": 50,
  "BranchName": "St. Louis",
  "Active": true,
  "InternalPropertyID": 70339,
  "InternalPropertyName": "Indirect St.Loiuse",
  "CatalogPriceListName": "Q - Main Prices 1111",
  "BranchAddressID": 34121,
  "BranchAddressLine1": "390 S Woods Mill Rd Suite 200",
  "BranchAddressLine2": "390 S Woods Mill Rd Suite 200",
  "BranchAddressCity": "Chesterfield",
  "BranchAddressStateProvinceCode": "MO",
  "BranchAddressZipCode": "63017",
  "BranchPhone": "(636) 000-0000",
  "BranchFax": "(636) 000-0000",
  "BranchCode": "STL",
  "BranchManagerContactID": 67654,
  "BranchManagerContactName": "Name Adela",
  "LegalName": "Company",
  "TimeZone": "Eastern Standard Time",
  "InvoiceNumberPrefix": "STL",
  "ReceiptNumberPrefix": null,
  "OpportunityNumberPrefix": "STL",
  "RegionID": 5,
  "RegionName": "Southwest Region",
  "BillingEmailFromAccountOwner": true,
  "BillingEmailFromUserName": null,
  "BillingEmailFromEmail": null,
  "BillingEmailSubject": null,
  "BillingEmailBody": "<div style=\"font-size: 14pt;\" id=\"fontFamilySizeSetting\"><div style=\"font-family: Arial,Helvetica,sans-serif;\" id=\"fontFamilySetting\"><p><span></span>
</p><p>
</p></div></div>",
  "InvoiceOnCompletionDescription": null,
  "BranchWebSite": "test",
  "CatalogPriceListID": 31,
  "BillingEmailCC": null
 }
]

Code Sample 

curl --request GET \
--url ("https://cloud-api.youraspire.com/Branches?%24filter=(startswith(BranchName%2C%20'St.')%20and%20contains(BranchAddressLine1%2C%20'39000%20S%20Woods'))%20or%20contains(LegalName%2C%20'Incrediscape')")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVVBdXRvVGltZUFjY2VwdGFuY2VDb25maWdcIjpmYWxzZSxcIkVuYWJsZUF1dG9UaW1lQWNjZXB0YW5jZVwiOmZhbHNlLFwiRW50ZXJwcmlzZUFkbWluVHlwZVwiOjB9IiwiRm9yYmlkZGVuIjoiIiwibmJmIjoxNzA0Njg0Njc2LCJleHAiOjE3MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

DateTime functions: 

• second
• minute
• hour
• day
• month
• year
• time

Example Response 

[
 {
  "OpportunityID": 20573,
  "PropertyID": 32671,
  "OpportunityStatusID": 510,
  "OpportunityStatusName": "Lost",
  "SalesRepContactID": 22601,
  "SalesRepContactName": "Sally Salesrep",
  "OperationsManagerContactID": 22596,
  "OperationsManagerContactName": "Joe Barry",
  "DivisionID": 90,
  "DivisionName": "Enhancement",
  "BranchID": 50,
  "BranchName": "St. Louis",
  "SalesTypeID": 29,
  "SalesTypeName": "New Sale",
  "TemplateOpportunityID": null,
  "LeadSourceID": null,
  "LeadSourceName": null,
  "MasterOpportunityID": null,
  "BillingAddressID": 34110,
  "BillingAddressLine1": "1 Barnes Jewish Hospital Plaza",
  "BillingAddressLine2": null,
  "BillingAddressCity": "St. Louis",
  "BillingAddressStateProvinceCode": "MO",
  "BillingAddressZipCode": "63521",
  "OpportunityType": "Work Order",
  "MasterSequenceNum": null,
  "OpportunityName": "Spring Mulch Refresh",
  "ProposalDescription1": "<div style=\"font-family: Verdana;\" id=\"fontFamilySetting\"><p>Test for Tab again         hjbhb</p><p>check   <span>[AccountOwnerContactHomePhone]</span></p><p><span>
</span></p><p></p><p><img src=\"https://aspire-clouduat-attach.youraspire.com/AspireUploads/15/opportunity/20573/1885795.jpg\" alt=\"common irrigation repair..jpg\" data-attachment=\"{"ExposeToCrew":false,"AttachToInvoice":false,"AttachmentSize":"MEDIUM","ActivityIDs":[],"ObjectCode":"OPPORTUNITY","OpportunityID":20573,"OriginalFileName":"common irrigation repair..jpg","AttachmentName":"common irrigation repair..jpg","AttachmentTypeID":34}\" width=\"360\" class=\"e-rte-image e-imginline\"></p><p></p><p>


</p><p></p><p>  
</p><p> 
</p></div>",
  "StartDate": "2016-11-01T00:00:00Z",
  "EndDate": "2016-12-31T00:00:00Z",
  "BidDueDate": null,
  "CreatedDateTime": "2016-11-08T20:44:01.07Z",
  "ApprovedDate": "2017-03-09T18:39:13.817Z",
  "ProposedDate": "2020-08-26T19:42:47.873Z",
  "WonDate": "2017-03-09T18:39:19.943Z",
  "LostDate": "2023-11-09T12:54:40.867Z",
  "Probability": 0,
  "AnticipatedCloseDate": null,
  "InvoiceType": "Fixed Price on Completion",
  "CustomerContractNum": null,
  "CustomerPONum": null,
  "BudgetedDollars": 0,
  "EstimatedDollars": 377.99,
  "StateTaxPercent": 9,
  "FederalTaxPercent": 0,
  "CreatedByUserID": 3197,
  "CreatedByUserName": "A User Name",
  "ApprovedUserID": 3317,
  "ApprovedUserName": "Joe Barry",
  "ProposedUserID": 3317,
  "ProposedUserName": "Joe Barry",
  "ClosedUserID": 3643,
  "ClosedUserName": "A Name",
  "CompetitorID": null,
  "CompetitorName": null,
  "LostReason": null,
  "BillingContactID": 22554,
  "BillingContactName": "Billing Contact",
  "ProposalDescription2": null,
  "OpportunityNumber": 1016,
  "EstimatedCostDollars": 147,
  "EstimatedOverheadDollars": 136.5,
  "EstimatedBreakEvenDollars": 283.5,
  "EstimatedNetProfitPercent": 25,
  "EstimatedNetProfitDollars": 94.49,
  "EstimatedGrossMarginPercent": 61.11,
  "EstimatedGrossMarginDollars": 230.99,
  "EstimatedLaborHours": 3,
  "EstimatedLaborCostPerHour": 35,
  "EstimatedRealizeRate": 98,
  "EstimatedEquipmentCost": 0,
  "EstimatedLaborCost": 105,
  "EstimatedMaterialCost": 42,
  "EstimatedOtherCost": 0,
  "EstimatedSubCost": 0,
  "ActualCostDollars": 528.55,
  "ActualGrossMarginPercent": -196.95,
  "ActualGrossMarginDollars": -350.56,
  "ActualLaborHours": 18.5,
  "ActualLaborCostPerHour": 26.3,
  "ActualEarnedRevenue": 177.99,
  "InvoiceNote": "<p>Refresh spring mulch in March in all areas of property.</p>",
  "PercentComplete": 1,
  "RenewalDate": null,
  "ModifiedByUserID": 3317,
  "ModifiedByUserName": "Joe Barry",
  "ModifiedDate": "2023-12-04T16:24:08.617Z",
  "OverridePaymentTermsID": 41,
  "OverridePaymentTerms": "Net 30",
  "RetainagePercent": null,
  "EstimatorNotes": "<p>Purchase extra mulch anticipate it will be needed. </p>",
  "ElectronicPaymentsOverrideConvenienceFee": null,
  "OpportunityCanceledReasonID": null,
  "OpportunityCanceledReason": null,
  "RetainageMaturityDate": null,
  "DistrictName": "District West13",
  "JobStatusName": "Complete",
  "RegionName": "Southwest Region",
  "PaymentTermsID": 41,
  "BillingCompanyID": 7683,
  "BillingCompanyName": "BJC",
  "BranchCode": "STL",
  "PropertyName": "Barnes Jewish Hospital",
  "DivisionCode": "EN",
  "TaxablePercent": 0,
  "TaxableAmount": 0,
  "TMPerServiceTaxableAmount": 0,
  "ActualCostSub": 0,
  "ActualCostMaterial": 42,
  "ActualCostLabor": 486.55,
  "CompleteDate": "2017-03-09T18:47:52.243Z",
  "OpportunityRevisions": [],
  "OpportunityBillings": [],
  "ScheduleOfValueGroups": []
 }
]

Code Sample

curl --request GET \
--url ("https://cloud-api.youraspire.com/Opportunities?%24filter=Date(WonDate)%20eq%202023-02-28%20or%20Year(LostDate)%20ne%202022")
--header ("Authorization", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dFwiOjEyMDIsXCJSZXF1aXJlTm9PcGVuSW52b2ljZXNDaGVja1wiOnRydWUsXCJQcm9kdWN0VGllclwiOjAsXCJDYW5BY2Nlc3NBUElzXCI6ZmFsc2UsXCJIYXNGYWNpYWxSZWNcIjpmYWxzZSxcIkVuYWJsZVRha2VvZmZJbnRlZ3JhdGlvblwiOnRydWUsXCJUYWtlb2ZmSW50ZWdyYXRpb25UeXBlXCI6NyxcIkRlZmF1bHRQcm9wZXJ0eVRha2VvZmZQcm92aWRlclwiOjQsXCJEZWZhdWx0RXN0aW1hdGVUYWtlb2ZmUHJvdmlkZXJcIjo0LFwiRW5hYmxlV2ViUmVwb3J0RGVzaWduZXJcIjpmYWxzZSxcIkF6dWdhQ3VzdG9tZXJJRFwiOjEwNTksXCJFbmFibGVDcmV3TWVtYmVyQ2xvY2tJbldpdGhvdXRDcmV3TGVhZGVyXCI6ZmFsc2UsXCJFbmFibGVFT01SZXBvcnRcIjpmYWxzZSxcIlVzZU9wcG9ydHVuaXR5SXRlbURpc3BsYXlOYW1lT25JbnZvaWNlXCI6dHJ1ZSxcIkVuYWJsZVZpc2l0Q2hlY2tsaXN0c1wiOnRydWUsXCJUaW1lWm9uZVwiOlwiQW1lcmljYS9DaGljYWdvXCIsXCJGaXJzdERheU9mV2Vla1wiOlwiTW9uZGF5XCIsXCJJbm92YUVuYWJsZWRcIjp0cnVlLFwiUFRPVmlzaWJsZVwiOnRydWUsXCJNYXJrZXRpbmdQcm9JbnRlZ3JhdGlvblwiOmZhbHNlLFwiTWFya2V0aW5nUHJvVmVyc2lvblwiOm51bGwsXCJFbmFibGVBdXRvVGltZUFjY2VwdGFuY2VDb25maWdcIjpmYWxzZSxcIkVuYWJsZUF1dG9UaW1lQWNjZXB0YW5jZVwiOmZhbHNlLFwiRW50ZXJwcmlzZUFkbWluVHlwZVwiOjB9IiwiRm9yYmlkZGVuIjoiIiwibmJmIjoxNzA0Njg0Njc2LCJleHAiOjE3MDQ3NzEwNzYsImlhdCI6MTcwNDY4NDY3Nn0.FALf4zF0kIAf-pZPVmj8wChCDxGRaVuxQPHrzUy-Df0")
--header ("accept", "application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json")

 $select

• Use to pinpoint specific data properties that should be included in the response from the request you have built. This expedites the transfer of information because you can minimize the unneeded information that can be returned in the response.
• You can use the select query on any field for a given endpoint if the field is not nested in an object. A nested object or property requires using the $expand query with $select.   
• Separate multiple properties or fields within the $select clause using commas, not spaces. 

Example Response 

[
 {
  "CompanyName": "Landscape, Inc.",
  "ContactTypeName": "Customer",
  "FirstName": "Aspire",
  "LastName": "Company"
 },
 {
  "CompanyName": "Landscape, Inc.",
  "ContactTypeName": "Employee",
  "FirstName": "Suzy",
  "LastName": "Moon"
 },
 {
  "CompanyName": "Busch Enterprises",
  "ContactTypeName": "Customer",
  "FirstName": "Robert",
  "LastName": "Hugh"
 },
 {
  "CompanyName": "National Art Corporation",
  "ContactTypeName": "Customer",
  "FirstName": "Kendra",
  "LastName": "Farquod"
 },
]

Code Sample

curl --request GET \
  --url 'https://cloud-api.youraspire.com/Contacts?%24select=FirstName%2CLastName%2CCompanyName%2CContactTypeName' \
  --header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI6dHJ1mZhbHNlLFwiVXNlT3Bwb3J0dW5pdHlJdGVtRGlzcGxheU5hbWVPbkludm9pY2VcIjp0cnVlLFwiRW5hYmxlVmlzaXRDaGVja2xpc3RzXCI6dHJ1ZSxcIlRpbWVab25lXCI6XCJBbWVyaWNhL0NoaWNhZ29cIixcIkZpcnN0RGF5T2ZXZWVrXCI6XCJNb25kYXlcIixcIklub3ZhRW5hYmxlZFwiOnRydWUsXCJQVE9WaXNpYmxlXCI6dHJ1ZSxcIk1hcmtldGluZ1Byb0ludGVncmF0aW9uXCI6ZmFsc2UsXCJNYXJrZXRpbmdQcm9WZXJzaW9uXCI6bnVsbCxcIkVuYWJsZUF1dG9UaW1lQWNjZXB0YW5jZUNvbmZpZ1wiOmZhbHNlLFwiRW5hYmxlQXV0b1RpbWVBY2NlcHRhbmNlXCI6ZmFsc2UsXCJFbnRlcnByaXNlQWRtaW5UeXBlXCI6MH0iLCJGb3JiaWRkZW4iOiIiLCJuYmYiOjE3MDU0MjgyNTEsImV4cCI6MTcwNTUxNDY1MSwiaWF0IjoxNzA1NDI4MjUxfQ.Ray35HwIZrMEFZz_MmEAECDy75zr30sOGceKUSyldQw' \
  --header 'accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json'

$orderby

• Use to sort the order of your results using the data type of the chosen field or property. 
• By default, the order of the returned value is sorted in ascending order. 
• Use asc to determine that the order should be ascending and descending to determine that the order should be descending. 

Response Example 

[
 {
  "DivisionID": 233,
  "DivisionName": "Kendal Test Division",
  "Active": true,
  "DivisionCode": "dadasd",
  "Indirect": true,
  "WorkersCompID": null,
  "WorkersCompName": null,
  "AccountNumber": null,
  "MaterialExpenseAccountNumber": null,
  "EquipmentExpenseAccountNumber": null,
  "SubExpenseAccountNumber": null,
  "OtherExpenseAccountNumber": null
 },
 {
  "DivisionID": 234,
  "DivisionName": "Janitorial",
  "Active": true,
  "DivisionCode": "dadada",
  "Indirect": false,
  "WorkersCompID": 5,
  "WorkersCompName": "Mowing",
  "AccountNumber": null,
  "MaterialExpenseAccountNumber": null,
  "EquipmentExpenseAccountNumber": null,
  "SubExpenseAccountNumber": null,
  "OtherExpenseAccountNumber": null
 },
 {
  "DivisionID": 253,
  "DivisionName": "Christina's division",
  "Active": true,
  "DivisionCode": null,
  "Indirect": false,
  "WorkersCompID": 14,
  "WorkersCompName": "Heavy Equipment",
  "AccountNumber": null,
  "MaterialExpenseAccountNumber": null,
  "EquipmentExpenseAccountNumber": null,
  "SubExpenseAccountNumber": null,
  "OtherExpenseAccountNumber": null
 },
 {
  "DivisionID": 273,
  "DivisionName": "GPS Testing Division",
  "Active": false,
  "DivisionCode": "GPS",
  "Indirect": false,
  "WorkersCompID": null,
  "WorkersCompName": null,
  "AccountNumber": null,
  "MaterialExpenseAccountNumber": null,
  "EquipmentExpenseAccountNumber": null,
  "SubExpenseAccountNumber": null,
  "OtherExpenseAccountNumber": null
 },
 {
  "DivisionID": 303,
  "DivisionName": "Maintenance - Derek",
  "Active": true,
  "DivisionCode": "1313",
  "Indirect": false,
  "WorkersCompID": null,
  "WorkersCompName": null,
  "AccountNumber": null,
  "MaterialExpenseAccountNumber": null,
  "EquipmentExpenseAccountNumber": null,
  "SubExpenseAccountNumber": null,
  "OtherExpenseAccountNumber": null
 }
}

Code Sample 

curl --request GET \
  --url 'https://cloud-api.youraspire.com/Divisions?%24orderby=AccountNumber%20asc' \
  --header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBbmRIb3Vyc1wiOnRydWUsXCJDcmVhdGVFcXVpcG1lbnRJbnNwZWN0aW9uc1wiOnRydWUsXCJSZWNlaXZlUmVjZWlwdFwiOnRydWUsXCJNYW5hZ2VOb3RpZmljYXRpb25zU3lzdGVtXCI6dHJ1ZSxcIk1hbmFnZU5vdGlmaWNhdGlvbnNCcmFuY2hcIjp0cnVlLFwiUmVwb3J0V2ViRGVzaWduZXJcIjp0cnVlLFwiVmlld0ludmVudG9yeUxvY2F0aW9uc1wiOnRydWUsXCJFZGl0SW52ZW50b3J5TG9jYXRpb25zXCI6dHJ1ZSxcIlJvbGVQZXJtaXNzaW9uXCI6W10sXCJMb2NhbEJyYW5jaEFkbWluXCI6ZmFsc2UsXCJIYXNBbnlSZXBvcnRBY2Nlc3NcIjpmYWxzZX0iLCJBc3BpcmVTeXN0ZW1TZXR0aW5ncyI6IntcIkNvbXBhbnlOYW1lXCI6XCJJbmNyZWRpc2NhcGUgVUFUXCIsXCJFc3RpbWF0ZUxpY2Vuc2VcIjp0cnVlLFwiVGlja2V0TWFuYWdlbWVudExpY2Vuc2VcIjp0cnVlLFwiRXN0aW1hdGluZ1N0YWdpbmdcIjpmYWxzZSxcIkludm9pY2luZ0xpY2Vuc2VcIjp0cnVlLFwiQVJNYW5hZ2VtZW50TGljZW5zZVwiOnRydWUsXCJCaWxsaW5nRW1haWxGcm9tQWNjb3VudE93bmVyXCI6ZmFsc2UsXCJQYXljaGV4SW5jbHVkZURhdGVzXCI6dHJ1ZSxcIlJlcXVpcmVVbmlxdWVWZW5kb3JJbnZvaWNlTnVtYmVyXCI6ZmFsc2UsXCJSZXN0cmljdEVkaXRpbmdFbXBsb3llZXNcIjpmYWxzZSxcIkNyZWF0ZVByb3BlcnR5RnJvbUNvbnRhY3RcIjp0cnVlLFwiRW5hYmxlRWxlY3Ryb25pY1NpZ25hdHVyZXNcIjp0cnVlLFwiTWFzdGVyU3lzdGVtXCI6ZmFsc2UsXCJTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI6dHJ1ZSxcIlJvdW5kQ2xvY2tJbk91dFRpbWVzXCI6ZmFsc2UsXCJPTEFQUGl2b3RFbmFibGVkXCI6dHJ1ZSxcIkRpc2FibGVBdXRvbWF0aWNBcHByb3ZhbFwiOnRydWUsXCJEaXNhYmxlTW9iaWxlQ3Jld01hbmFnZW1lbnRcIjpmYWxzZSxcIkRpc2FibGVEZWxldGlvbk9mV29ya1RpY2tldHNcIjpmYWxzZSxcIkFsbG93U3ViVG9Mb2dpblwiOnRydWUsXCJIaWRlU2NoZWR1bGVQcm9ncmVzc0JhclwiOmZhbHNlLFwiV2Fybk9uRWFybHlMdW5jaENsb2NraW5cIjoyLFwiQ2FsaWZvcm5pYVRpbWVQcm9tcHRzXCI6ZmFsc2UsXCJJbnZvaWNpbmdBc3Npc3RhbnRSZXF1aXJlQmlsbGluZ0NvbXBhbnlcIjp0cnVlLFwiRW5mb3JjZUJyYW5jaEFkbWluQWRtaW5pc3RyYXRpb25TZWN1cml0eVwiOnRydWUsXCJPVENhbGN1bGF0aW9uXCI6XCJPdmVycmlkZSBQYXljb2RlXCIsXCJFcXVpcG1lbnRSZWFkaW5nQ2xvY2tPdXRQcm9tcHRcIjpcIkVuZCBvZiBEYXlcIixcIlNob3dOZXRHcm9zc01hcmdpbk9uRXN0aW1hdGluZ1NjcmVlblwiOnRydWUsXCJTaG93T25seUdyb3NzTWFyZ2lub25Fc3RpbWF0aW5nU2NyZWVuXCI6ZmFsc2UsXCJDcmVhdGVFcXVpcG1lbnRSZWFkaW5nc1wiOnRydWUsXCJJbmNsdWRlRHJpdmVUaW1lV2hlbkxvZ2dpbmdFcXVpcG1lbnRDcmV3TW9iaWxlXCI6dHJ1ZSxcIkVuYWJsZU5lZ2F0aXZlQ2hhbmdlT3JkZXJzXCI6dHJ1ZSxcIkVuYWJsZUN1c3RvbWVyUG9ydGFsXCI6dHJ1ZSxcIkRlZmF1bHRHRU9QZXJpbWV0ZXJcIjo1MDAuMCxcIkVuYWJsZUFzcGlyZUdQU0ludGVncmF0aW9uXCI6dHJ1ZSxcIkVuYWJsZUVxdWlwbWVudE1vZHVsZUFkZE9uXCI6dHJ1ZSxcIkdQU0ludGVncmF0aW9uUHJvdmlkZXJcIjozLFwiRW5hYmxlRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIkVuYWJsZVNpdGVPbmVcIjpmYWxzZSxcIkJyZWFrVGltZVwiOjAuNSxcIlBheWNoZXhFeHBvcnRGb3JtYXRcIjpcIkRlZmF1bHQgQ1NWXCIsXCJFbmFibGVQYXJ0aWFsVGltZU9uU3ViUG9ydGFsXCI6dHJ1ZSxcIkVuYWJsZVBhcnRpYWxUaW1lT25DcmV3TW9iaWxlXCI6dHJ1ZSxcIkVuYWJsZUxhbmRzY2FwZUh1YkludGVncmF0aW9uXCI6dHJ1ZSxcIkRpc3BsYXlUYXhPbkVzdGltYXRlXCI6dHJ1ZSxcIkxpbmtTY2hlZHVsZW9mVmFsdWV0b1NlcnZpY2VCeURlZmF1bHRcIjpmYWxzZSxcIkVuYWJsZVdlYXRoZXJtYXRpY0ludGVncmF0aW9uXCI6dHJ1ZSxcIkFkdmFuY2VkU2VhcmNoU2VsZWN0VG9wTnVtYmVyXCI6NTAwMCxcIkVuYWJsZU92ZXJVbmRlckFkanVzdG1lbnRzXCI6dHJ1ZSxcIkRlZmF1bHREaXZpc2lvbklERm9yV29ya09yZGVyc1wiOjAsXCJEZWZhdWx0Rm9udFwiOlwiVmVyZGFuYSxzYW5zLXNlcmlmXCIsXCJEZWZhdWx0Rm9udFNpemVcIjpcIjE0LjAwXCIsXCJDcmV3TGVhZGVyUm9sZUlEXCI6MTIwMixcIlJlcXVpcmVOb09wZW5JbnZvaWNlc0NoZWNrXCI6dHJ1ZSxcIlByb2R1Y3RUaWVyXCI6MCxcIkNhbkFjY2Vzc0FQSXNcIjpmYWxzZSxcIkhhc0ZhY2lhbFJlY1wiOmZhbHNlLFwiRW5hYmxlVGFrZW9mZkludGVncmF0aW9uXCI6dHJ1ZSxcIlRha2VvZmZJbnRlZ3JhdGlvblR5cGVcIjo3LFwiRGVmYXVsdFByb3BlcnR5VGFrZW9mZlByb3ZpZGVyXCI6NCxcIkRlZmF1bHRFc3RpbWF0ZVRha2VvZmZQcm92aWRlclwiOjQsXCJFbmFibGVXZWJSZXBvcnREZXNpZ25lclwiOmZhbHNlLFwiQXp1Z2FDdXN0b21lcklEXCI6MTA1OSxcIkVuYWJsZUNyZXdNZW1iZXJDbG9ja0luV2l0aG91dENyZXdMZWFkZXJcIjpmYWxzZSxcIkVuYWJsZUVPTVJlcG9ydFwiOmZhbHNlLFwiVXNlT3Bwb3J0dW5pdHlJdGVtRGlzcGxheU5hbWVPbkludm9pY2VcIjp0cnVlLFwiRW5hYmxlVmlzaXRDaGVja2xpc3RzXCI6dHJ1ZSxcIlRpbWVab25lXCI6XCJBbWVyaWNhL0NoaWNhZ29cIixcIkZpcnN0RGF5T2ZXZWVrXCI6XCJNb25kYXlcIixcIklub3ZhRW5hYmxlZFwiOnRydWUsXCJQVE9WaXNpYmxlXCI6dHJ1ZSxcIk1hcmtldGluZ1Byb0ludGVncmF0aW9uXCI6ZmFsc2UsXCJNYXJrZXRpbmdQcm9WZXJzaW9uXCI6bnVsbCxcIkVuYWJsZUF1dG9UaW1lQWNjZXB0YW5jZUNvbmZpZ1wiOmZhbHNlLFwiRW5hYmxlQXV0b1RpbWVBY2NlcHRhbmNlXCI6ZmFsc2UsXCJFbnRlcnByaXNlQWRtaW5UeXBlXCI6MH0iLCJGb3JiaWRkZW4iOiIiLCJuYmYiOjE3MDU0MjgyNTEsImV4cCI6MTcwNTUxNDY1MSwiaWF0IjoxNzA1NDI4MjUxfQ.Ray35HwIZrMEFZz_MmEAECDy75zr30sOGceKUSyldQw' \
  --header 'accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json'

Pagination query options 

Use pagination query options to limit the amount of data that is returned at one time. 

$top, $skip, and $limit require the input of integers only. 

• $limit - can only be used with $pageNumber to limit the amount of items returned on a page (page size). By default, the limit is 1000 records per page. 
• $pageNumber - go to a specific results page number. 
• $top  -  limit number of items returned. It must be a positive integer.
• $skip - skip the number of objects before retrieving the result. It must be a positive integer. 

$top

Use to limit the number of results returned after sending the request by specifying the maximum number of records to include at the top of the response. Use independently or in conjunction with the $skip query option. 

• Integers only.
• Use both  $top and  $skip are used in conjunction. 

Example Response

[
 {
  "ContactID": 22536,
  "CompanyID": 7885,
  "CompanyName": "Landscape, Inc.",
  "ContactTypeID": 1055,
  "ContactTypeName": "Customer",
  "OfficeAddress": {
   "AddressID": 34195,
   "AddressLine1": "Line 1",
   "AddressLine2": "Line 2",
   "City": "Saint Peters",
   "StateProvinceCode": "MO",
   "ZipCode": "63376",
   "CreatedByUserId": 3979,
   "CreatedOn": "2023-04-15T04:30:02.61Z",
   "LastModifiedByUserId": 3316,
   "LastModifiedOn": "2023-04-17T04:30:02.61Z"
  },
  "HomeAddress": {
   "AddressID": 44787,
   "AddressLine1": "Line 1",
   "AddressLine2": "Line 2",
   "City": "Sarajevo",
   "StateProvinceCode": null,
   "ZipCode": "71000",
   "CreatedByUserId": 3979,
   "CreatedOn": "2023-04-15T04:30:02.61Z",
   "LastModifiedByUserId": 3316,
   "LastModifiedOn": "2023-04-17T04:30:02.61Z"
  },
  "BranchID": 50,
  "BranchName": "St. Louis",
  "OwnerContactID": 22597,
  "OwnerContactName": "Bill Bags",
  "Salutation": null,
  "FirstName": "Aspire",
  "LastName": "Customer",
  "ProspectRating": "2",
  "ProspectRatingName": "Warm",
  "Title": "Ownerr",
  "Email": "user@email.com",
  "MobilePhone": null,
  "OfficePhone": "(314) 954-7519",
  "HomePhone": "(314) 954-7519",
  "Fax": null,
  "Notes": "Testing Save in Mobile interface on 3/20/2017\r\nkendal.walton@youraspire.com",
  "Active": true,
  "CreatedDateTime": null,
  "CreatedByUserID": null,
  "CreatedByUserName": null,
  "EmployeeNumber": "1164",
  "Website": null,
  "EmployeePin": "9219009",
  "AccountingSyncID": "1",
  "ExternalContactReference": "2",
  "TerminationDate": "2020-04-21T00:00:00Z",
  "HRNotes": null,
  "DefaultWorkersCompID": 13,
  "DefaultWorkersCompName": "Brick Laying",
  "DefaultWorkersCompStateProvinceCode": "AL",
  "UserID": 3197,
  "CrewSize": null,
  "PromptForCrewSize": false,
  "SubCrewLeaderContactID": null,
  "PayScheduleID": 38,
  "ModifiedDate": "2023-12-21T11:22:21.49Z",
  "ContactTags": []
 },
 {
  "ContactID": 22537,
  "CompanyID": 7885,
  "CompanyName": "Landscape, Inc.",
  "ContactTypeID": 1056,
  "ContactTypeName": "Employee",
  "OfficeAddress": {
   "AddressID": 34196,
   "AddressLine1": "",
   "AddressLine2": "",
   "City": "Saint Peters",
   "StateProvinceCode": "MO",
   "ZipCode": "63376",
   "CreatedByUserId": 3979,
   "CreatedOn": "2023-04-15T04:30:02.61Z",
   "LastModifiedByUserId": null,
   "LastModifiedOn": null
  },
  "HomeAddress": null,
  "BranchID": 50,
  "BranchName": "St. Louis",
  "OwnerContactID": 22597,
  "OwnerContactName": "Bill Bags",
  "Salutation": "Ms.",
  "FirstName": "Suzy",
  "LastName": "April",
  "ProspectRating": "2",
  "ProspectRatingName": "Warm",
  "Title": "Account Manager",
  "Email": "",
  "MobilePhone": "",
  "OfficePhone": "",
  "HomePhone": "",
  "Fax": "",
  "Notes": "",
  "Active": false,
  "CreatedDateTime": "2016-03-01T16:47:30.977Z",
  "CreatedByUserID": null,
  "CreatedByUserName": null,
  "EmployeeNumber": "",
  "Website": "",
  "EmployeePin": "",
  "AccountingSyncID": "",
  "ExternalContactReference": null,
  "TerminationDate": null,
  "HRNotes": null,
  "DefaultWorkersCompID": null,
  "DefaultWorkersCompName": null,
  "DefaultWorkersCompStateProvinceCode": null,
  "UserID": null,
  "CrewSize": null,
  "PromptForCrewSize": false,
  "SubCrewLeaderContactID": null,
  "PayScheduleID": null,
  "ModifiedDate": null,
  "ContactTags": []
 },
 {
  "ContactID": 22538,
  "CompanyID": 7671,
  "CompanyName": "Busch Enterprises",
  "ContactTypeID": 1055,
  "ContactTypeName": "Customer",
  "OfficeAddress": {
   "AddressID": 30537,
   "AddressLine1": "1200 treet",
   "AddressLine2": null,
   "City": "St. Louis",
   "StateProvinceCode": "MO",
   "ZipCode": "63118",
   "CreatedByUserId": 3979,
   "CreatedOn": "2023-04-15T04:30:02.61Z",
   "LastModifiedByUserId": null,
   "LastModifiedOn": null
  },
  "HomeAddress": {
   "AddressID": 41137,
   "AddressLine1": null,
   "AddressLine2": null,
   "City": null,
   "StateProvinceCode": null,
   "ZipCode": null,
   "CreatedByUserId": 3979,
   "CreatedOn": "2023-04-15T04:30:02.61Z",
   "LastModifiedByUserId": null,
   "LastModifiedOn": null
  },
  "BranchID": 50,
  "BranchName": "St. Louis",
  "OwnerContactID": 23214,
  "OwnerContactName": "My Name",
  "Salutation": null,
  "FirstName": "Robert",
  "LastName": "Hugh",
  "ProspectRating": "2",
  "ProspectRatingName": "Warm",
  "Title": "Property Manager",
  "Email": "Robert.H@gmail.comx",
  "MobilePhone": "",
  "OfficePhone": "314-555-6656",
  "HomePhone": null,
  "Fax": null,
  "Notes": null,
  "Active": true,
  "CreatedDateTime": "2016-03-01T16:47:30.993Z",
  "CreatedByUserID": null,
  "CreatedByUserName": null,
  "EmployeeNumber": "",
  "Website": "stlouis.cardinals.mlb.com",
  "EmployeePin": "",
  "AccountingSyncID": "",
  "ExternalContactReference": "",
  "TerminationDate": null,
  "HRNotes": null,
  "DefaultWorkersCompID": null,
  "DefaultWorkersCompName": null,
  "DefaultWorkersCompStateProvinceCode": null,
  "UserID": null,
  "CrewSize": null,
  "PromptForCrewSize": false,
  "SubCrewLeaderContactID": null,
  "PayScheduleID": null,
  "ModifiedDate": "2023-11-22T16:28:32.217Z",
  "ContactTags": []
 }
]

Code Sample

curl --request GET \
  --url 'https://cloud-api.youraspire.com/Contacts?%24top=3' \
  --header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBbmRIb3Vyc1wiOnRydWUsXCJDcmVhdGVFcXVpcG1lbnRJbnNwZWN0aW9uc1wiOnRydWUsXCJSZWNlaXZlUmVjZWlwdFwiOnRydWUsXCJNYW5hZ2VOb3RpZmljYXRpb25zU3lzdGVtXCI6dHJ1ZSxcIk1hbmFnZU5vdGlmaWNhdGlvbnNCcmFuY2hcIjp0cnVlLFwiUmVwb3J0V2ViRGVzaWduZXJcIjp0cnVlLFwiVmlld0ludmVudG9yeUxvY2F0aW9uc1wiOnRydWUsXCJFZGl0SW52ZW50b3J5TG9jYXRpb25zXCI6dHJ1ZSxcIlJvbGVQZXJtaXNzaW9uXCI6W10sXCJMb2NhbEJyYW5jaEFkbWluXCI6ZmFsc2UsXCJIYXNBbnlSZXBvcnRBY2Nlc3NcIjpmYWxzZX0iLCJBc3BpcmVTeXN0ZW1TZXR0aW5ncyI6IntcIkNvbXBhbnlOYW1lXCI6XCJJbmNyZWRpc2NhcGUgVUFUXCIsXCJFc3RpbWF0ZUxpY2Vuc2VcIjp0cnVlLFwiVGlja2V0TWFuYWdlbWVudExpY2Vuc2VcIjp0cnVlLFwiRXN0aW1hdGluZ1N0YWdpbmdcIjpmYWxzZSxcIkludm9pY2luZ0xpY2Vuc2VcIjp0cnVlLFwiQVJNYW5hZ2VtZW50TGljZW5zZVwiOnRydWUsXCJCaWxsaW5nRW1haWxGcm9tQWNjb3VudE93bmVyXCI6ZmFsc2UsXCJQYXljaGV4SW5jbHVkZURhdGVzXCI6dHJ1ZSxcIlJlcXVpcmVVbmlxdWVWZW5kb3JJbnZvaWNlTnVtYmVyXCI6ZmFsc2UsXCJSZXN0cmljdEVkaXRpbmdFbXBsb3llZXNcIjpmYWxzZSxcIkNyZWF0ZVByb3BlcnR5RnJvbUNvbnRhY3RcIjp0cnVlLFwiRW5hYmxlRWxlY3Ryb25pY1NpZ25hdHVyZXNcIjp0cnVlLFwiTWFzdGVyU3lzdGVtXCI6ZmFsc2UsXCJTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI6dHJ1ZSxcIlJvdW5kQ2xvY2tJbk91dFRpbWVzXCI6ZmFsc2UsXCJPTEFQUGl2b3RFbmFibGVkXCI6dHJ1ZSxcIkRpc2FibGVBdXRvbWF0aWNBcHByb3ZhbFwiOnRydWUsXCJEaXNhYmxlTW9iaWxlQ3Jld01hbmFnZW1lbnRcIjpmYWxzZSxcIkRpc2FibGVEZWxldGlvbk9mV29ya1RpY2tldHNcIjpmYWxzZSxcIkFsbG93U3ViVG9Mb2dpblwiOnRydWUsXCJIaWRlU2NoZWR1bGVQcm9ncmVzc0JhclwiOmZhbHNlLFwiV2Fybk9uRWFybHlMdW5jaENsb2NraW5cIjoyLFwiQ2FsaWZvcm5pYVRpbWVQcm9tcHRzXCI6ZmFsc2UsXCJJbnZvaWNpbmdBc3Npc3RhbnRSZXF1aXJlQmlsbGluZ0NvbXBhbnlcIjp0cnVlLFwiRW5mb3JjZUJyYW5jaEFkbWluQWRtaW5pc3RyYXRpb25TZWN1cml0eVwiOnRydWUsXCJPVENhbGN1bGF0aW9uXCI6XCJPdmVycmlkZSBQYXljb2RlXCIsXCJFcXVpcG1lbnRSZWFkaW5nQ2xvY2tPdXRQcm9tcHRcIjpcIkVuZCBvZiBEYXlcIixcIlNob3dOZXRHcm9zc01hcmdpbk9uRXN0aW1hdGluZ1NjcmVlblwiOnRydWUsXCJTaG93T25seUdyb3NzTWFyZ2lub25Fc3RpbWF0aW5nU2NyZWVuXCI6ZmFsc2UsXCJDcmVhdGVFcXVpcG1lbnRSZWFkaW5nc1wiOnRydWUsXCJJbmNsdWRlRHJpdmVUaW1lV2hlbkxvZ2dpbmdFcXVpcG1lbnRDcmV3TW9iaWxlXCI6dHJ1ZSxcIkVuYWJsZU5lZ2F0aXZlQ2hhbmdlT3JkZXJzXCI6dHJ1ZSxcIkVuYWJsZUN1c3RvbWVyUG9ydGFsXCI6dHJ1ZSxcIkRlZmF1bHRHRU9QZXJpbWV0ZXJcIjo1MDAuMCxcIkVuYWJsZUFzcGlyZUdQU0ludGVncmF0aW9uXCI6dHJ1ZSxcIkVuYWJsZUVxdWlwbWVudE1vZHVsZUFkZE9uXCI6dHJ1ZSxcIkdQU0ludGVncmF0aW9uUHJvdmlkZXJcIjozLFwiRW5hYmxlRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIkVuYWJsZVNpdGVPbmVcIjpmYWxzZSxcIkJyZWFrVGltZVwiOjAuNSxcIlBheWNoZXhFeHBvcnRGb3JtYXRcIjpcIkRlZmF1bHQgQ1NWXCIsXCJFbmFibGVQYXJ0aWFsVGltZU9uU3ViUG9ydGFsXCI6dHJ1ZSxcIkVuYWJsZVBhcnRpYWxUaW1lT25DcmV3TW9iaWxlXCI6dHJ1ZSxcIkVuYWJsZUxhbmRzY2FwZUh1YkludGVncmF0aW9uXCI6dHJ1ZSxcIkRpc3BsYXlUYXhPbkVzdGltYXRlXCI6dHJ1ZSxcIkxpbmtTY2hlZHVsZW9mVmFsdWV0b1NlcnZpY2VCeURlZmF1bHRcIjpmYWxzZSxcIkVuYWJsZVdlYXRoZXJtYXRpY0ludGVncmF0aW9uXCI6dHJ1ZSxcIkFkdmFuY2VkU2VhcmNoU2VsZWN0VG9wTnVtYmVyXCI6NTAwMCxcIkVuYWJsZU92ZXJVbmRlckFkanVzdG1lbnRzXCI6dHJ1ZSxcIkRlZmF1bHREaXZpc2lvbklERm9yV29ya09yZGVyc1wiOjAsXCJEZWZhdWx0Rm9udFwiOlwiVmVyZGFuYSxzYW5zLXNlcmlmXCIsXCJEZWZhdWx0Rm9udFNpemVcIjpcIjE0LjAwXCIsXCJDcmV3TGVhZGVyUm9sZUlEXCI6MTIwMixcIlJlcXVpcmVOb09wZW5JbnZvaWNlc0NoZWNrXCI6dHJ1ZSxcIlByb2R1Y3RUaWVyXCI6MCxcIkNhbkFjY2Vzc0FQSXNcIjpmYWxzZSxcIkhhc0ZhY2lhbFJlY1wiOmZhbHNlLFwiRW5hYmxlVGFrZW9mZkludGVncmF0aW9uXCI6dHJ1ZSxcIlRha2VvZmZJbnRlZ3JhdGlvblR5cGVcIjo3LFwiRGVmYXVsdFByb3BlcnR5VGFrZW9mZlByb3ZpZGVyXCI6NCxcIkRlZmF1bHRFc3RpbWF0ZVRha2VvZmZQcm92aWRlclwiOjQsXCJFbmFibGVXZWJSZXBvcnREZXNpZ25lclwiOmZhbHNlLFwiQXp1Z2FDdXN0b21lcklEXCI6MTA1OSxcIkVuYWJsZUNyZXdNZW1iZXJDbG9ja0luV2l0aG91dENyZXdMZWFkZXJcIjpmYWxzZSxcIkVuYWJsZUVPTVJlcG9ydFwiOmZhbHNlLFwiVXNlT3Bwb3J0dW5pdHlJdGVtRGlzcGxheU5hbWVPbkludm9pY2VcIjp0cnVlLFwiRW5hYmxlVmlzaXRDaGVja2xpc3RzXCI6dHJ1ZSxcIlRpbWVab25lXCI6XCJBbWVyaWNhL0NoaWNhZ29cIixcIkZpcnN0RGF5T2ZXZWVrXCI6XCJNb25kYXlcIixcIklub3ZhRW5hYmxlZFwiOnRydWUsXCJQVE9WaXNpYmxlXCI6dHJ1ZSxcIk1hcmtldGluZ1Byb0ludGVncmF0aW9uXCI6ZmFsc2UsXCJNYXJrZXRpbmdQcm9WZXJzaW9uXCI6bnVsbCxcIkVuYWJsZUF1dG9UaW1lQWNjZXB0YW5jZUNvbmZpZ1wiOmZhbHNlLFwiRW5hYmxlQXV0b1RpbWVBY2NlcHRhbmNlXCI6ZmFsc2UsXCJFbnRlcnByaXNlQWRtaW5UeXBlXCI6MH0iLCJGb3JiaWRkZW4iOiIiLCJuYmYiOjE3MDU0MjgyNTEsImV4cCI6MTcwNTUxNDY1MSwiaWF0IjoxNzA1NDI4MjUxfQ.Ray35HwIZrMEFZz_MmEAECDy75zr30sOGceKUSyldQw' \
  --header 'accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json'

$skip

$skip is commonly used with $top for pagination. It is used to skip a specific number of records not at the top of the list.

• Integers only.
• Both $top and $skip are used in conjunction. 

Example Response

[
 {
  "ContactID": 63703,
  "CompanyID": 18958,
  "CompanyName": "Red Residential",
  "ContactTypeID": 2109,
  "ContactTypeName": "Prospect",
  "OfficeAddress": null,
  "HomeAddress": null,
  "BranchID": null,
  "BranchName": null,
  "OwnerContactID": null,
  "OwnerContactName": null,
  "Salutation": "",
  "FirstName": "Laura",
  "LastName": "S",
  "ProspectRating": null,
  "ProspectRatingName": null,
  "Title": "Regional Property Manager",
  "Email": "",
  "MobilePhone": "",
  "OfficePhone": "",
  "HomePhone": "",
  "Fax": "",
  "Notes": null,
  "Active": true,
  "CreatedDateTime": "2023-09-01T13:49:04.343Z",
  "CreatedByUserID": 3317,
  "CreatedByUserName": "Jo",
  "EmployeeNumber": null,
  "Website": null,
  "EmployeePin": null,
  "AccountingSyncID": null,
  "ExternalContactReference": null,
  "TerminationDate": null,
  "HRNotes": null,
  "DefaultWorkersCompID": null,
  "DefaultWorkersCompName": null,
  "DefaultWorkersCompStateProvinceCode": null,
  "UserID": null,
  "CrewSize": null,
  "PromptForCrewSize": null,
  "SubCrewLeaderContactID": null,
  "PayScheduleID": null,
  "ModifiedDate": null,
  "ContactTags": []
 },
 {
  "ContactID": 63704,
  "CompanyID": 18944,
  "CompanyName": "Unified School District",
  "ContactTypeID": 2109,
  "ContactTypeName": "Prospect",
  "OfficeAddress": null,
  "HomeAddress": null,
  "BranchID": null,
  "BranchName": null,
  "OwnerContactID": null,
  "OwnerContactName": null,
  "Salutation": "",
  "FirstName": "K",
  "LastName": "Ok",
  "ProspectRating": null,
  "ProspectRatingName": null,
  "Title": "Executive Director of Facilities and Construction",
  "Email": null,
  "MobilePhone": null,
  "OfficePhone": null,
  "HomePhone": "",
  "Fax": "",
  "Notes": null,
  "Active": true,
  "CreatedDateTime": "2023-09-01T13:49:04.39Z",
  "CreatedByUserID": 3317,
  "CreatedByUserName": "Jos",
  "EmployeeNumber": null,
  "Website": null,
  "EmployeePin": null,
  "AccountingSyncID": null,
  "ExternalContactReference": null,
  "TerminationDate": null,
  "HRNotes": null,
  "DefaultWorkersCompID": null,
  "DefaultWorkersCompName": null,
  "DefaultWorkersCompStateProvinceCode": null,
  "UserID": null,
  "CrewSize": null,
  "PromptForCrewSize": null,
  "SubCrewLeaderContactID": null,
  "PayScheduleID": null,
  "ModifiedDate": null,
  "ContactTags": []
 },

 Code Sample

curl --request GET \
  --url 'https://cloud.api.youraspire.com/Contacts?%24skip=4497&%24top=3' \
  --header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBc3BpcmVTeXN0ZW1JRCI6IjE1IiwiVXNlcklEIjoiNDg0OCIsIlVzZXJQZXJtaXNzaW9ucyI6IntcIlJvbGVJRFwiOjAsXCJSb2xlTmFtZVwiOm51bGwsXCJSZXF1aXJlZFwiOmZhbHNlLFwiUm9sZVZhbHVlXCI6MSxcIkFkZENvbnRhY3RcIjp0cnVlLFwiRWRpdE15Q29udGFjdHNcIjp0cnVlLFwiRWRpdEFsbENvbnRhY3RzXCI6dHJ1ZSxcIkRlbGV0ZUNvbnRhY3RcIjpmYWxzZSxcIkFkZEVtcGxveWVlSW5jaWRlbnRcIjp0cnVlLFwiRWRpdEFjY291bnRpbmdTeW5jSURcIjp0cnVlLFwiQnVsa0VtYWlsQ29udGFjdHNcIjp0cnVlLFwiU2VuZEN1c3RvbWVyUG9ydGFsSW52aXRhdGlvblwiOnRydWUsXCJJbXBvcnRDb250YWN0QW5kUHJvcGVydHlcIjp0cnVlLFwiQ29uZmlndXJlQ29udGFjdFJlcXVpcmVkRmllbGRzXCI6dHJ1ZSxcIkRlbGV0ZU1lcmdlQ29udGFjdHNcIjp0cnVlLFwiVXBkYXRlRW1wbG95ZWVQSU5cIjpmYWxzZSxcIkFkZFByb3BlcnR5XCI6dHJ1ZSxcIkVkaXRNeVByb3BlcnRpZXNcIjp0cnVlLFwiRWRpdEFsbFByb3BlcnRpZXNcIjp0cnVlLFwiRGVsZXRlUHJvcGVydHlcIjpmYWxzZSxcIkVkaXRRdWFsaXR5QXVkaXRzXCI6dHJ1ZSxcIlZpZXdQcm9wZXJ0aWVzXCI6dHJ1ZSxcIlZpZXdNeVByb3BlcnRpZXNcIjpmYWxzZSxcIkFkZE9wcG9ydHVuaXR5XCI6dHJ1ZSxcIkVkaXRNeU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRWRpdEFsbE9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiRGVsZXRlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiQ2hhbmdlT3Bwb3J0dW5pdHlcIjp0cnVlLFwiVmlld1JlYWRPbmx5RXN0aW1hdGVzXCI6dHJ1ZSxcIlVuY2FuY2VsT3Bwb3J0dW5pdHlcIjp0cnVlLFwiSm9iRGFzaGJvYXJkXCI6dHJ1ZSxcIkltcG9ydEVzdGltYXRlXCI6dHJ1ZSxcIkVkaXRTZXJ2aWNlUGF5Q29kZXNcIjp0cnVlLFwiRGVsZXRlQWN0aXZpdHlcIjp0cnVlLFwiU3lzdGVtQWRtaW5cIjp0cnVlLFwiQnJhbmNoQWRtaW5cIjpmYWxzZSxcIlZpZXdSb3V0ZXNcIjp0cnVlLFwiTWFuYWdlT3Bwb3J0dW5pdHlUZW1wbGF0ZXNcIjp0cnVlLFwiTWFuYWdlR2VuZXJhbENvbmRpdGlvblRlbXBsYXRlc1wiOnRydWUsXCJNYWtlVmlzaXRDaGVja2xpc3RJdGVtc01hbmRhdG9yeVwiOnRydWUsXCJFZGl0RGFpbHlQbGFuUmVwb3J0XCI6dHJ1ZSxcIk1hcmtldGluZ1Byb1wiOnRydWUsXCJFeHBvcnRHcmlkc1wiOnRydWUsXCJFZGl0VGVtcGxhdGVzXCI6dHJ1ZSxcIk1hbmFnZVRlbXBsYXRlc1wiOnRydWUsXCJFZGl0RXN0aW1hdGVQcmljaW5nUGN0XCI6dHJ1ZSxcIkVkaXRFc3RpbWF0ZUl0ZW1zXCI6dHJ1ZSxcIkhvdXJSZWR1Y3Rpb25QY3RcIjoxMDAuMCxcIlByaWNlUmVkdWN0aW9uUGN0XCI6MTAwLjAsXCJVbmJhbGFuY2VkUGF5bWVudFNjaGVkdWxlXCI6dHJ1ZSxcIkFsbG93T25lVGltZUl0ZW1zXCI6dHJ1ZSxcIkFkZEl0ZW1zVG9DYXRhbG9nXCI6dHJ1ZSxcIkNoYW5nZVNlcnZpY2VJbnZvaWNlVHlwZU9uRml4ZWRQcmljZU9wZW5CaWxsaW5nXCI6dHJ1ZSxcIkFkanVzdEdlbmVyYWxDb25kaXRpb25zXCI6dHJ1ZSxcIkFkZE1vZGlmeVBheWNvZGVPdmVycmlkZXNcIjp0cnVlLFwiQXNOZWVkZWRFeGNlcHRpb25SZXBvcnRcIjp0cnVlLFwiTWFrZU9wcG9ydHVuaXR5U2VydmljZVZpc2l0Q2hlY2tsaXN0SXRlbXNNYW5kYXRvcnlcIjp0cnVlLFwiUHJvZHVjdGlvblwiOmZhbHNlLFwiVXBkYXRlSm9iXCI6ZmFsc2UsXCJDYW5jZWxXb3JrVGlja2V0XCI6dHJ1ZSxcIlNjaGVkdWxlQm9hcmRcIjp0cnVlLFwiU2NoZWR1bGVCb2FyZFJlYWRPbmx5XCI6dHJ1ZSxcIlJvdXRlT3B0aW1pemF0aW9uXCI6dHJ1ZSxcIlNjaGVkdWxlQW5FdmVudFwiOnRydWUsXCJBY2Nlc3NBdXRvVGltZUFjY2VwdGFuY2VSZXBvcnRzXCI6ZmFsc2UsXCJFZGl0Um91dGVzXCI6dHJ1ZSxcIkNyZXdMZWFkZXJcIjp0cnVlLFwiRXN0aW1hdGVcIjpmYWxzZSxcIlZpZXdBbGxUaW1lXCI6dHJ1ZSxcIk15UmVwb3J0c1wiOnRydWUsXCJBZHZhbmNlZFNlYXJjaFN5c3RlbUFkbWluXCI6ZmFsc2UsXCJIUkFkbWluXCI6dHJ1ZSxcIlNhbGVzTWFuYWdlclwiOnRydWUsXCJFZGl0UHJvcGVydHlCaWxsaW5nQ29udGFjdFwiOnRydWUsXCJVbmFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVUaW1lXCI6dHJ1ZSxcIkV4cG9ydFRpbWVcIjp0cnVlLFwiRWRpdFByaWNpbmdcIjp0cnVlLFwiQ2hvb3NlUmVwb3J0RXhwb3J0VHlwZVwiOnRydWUsXCJFZGl0QnVkZ2V0XCI6dHJ1ZSxcIlVuYXBwcm92ZVRpbWVcIjp0cnVlLFwiVmlld1JlYWRPbmx5UGF5cm9sbERhdGFcIjp0cnVlLFwiSW5vdmFMYWJvckJ1cmRlblRydWVVcFwiOnRydWUsXCJDcmVhdGVPdmVyVW5kZXJBZGp1c3RtZW50UmVjb3Jkc1wiOnRydWUsXCJDcmVhdGVSZWNlaXB0XCI6dHJ1ZSxcIkFwcHJvdmVSZWNlaXB0XCI6dHJ1ZSxcIkRlbGV0ZVJlY2VpcHRcIjp0cnVlLFwiQWRkUHVyY2hhc2VDcmVkaXRcIjp0cnVlLFwiU3VibWl0UmVjZWlwdFRvTGFuZHNjYXBlSHViXCI6dHJ1ZSxcIkFsbG93RXN0aW1hdGVOZWdhdGl2ZVF1YW50aXR5XCI6dHJ1ZSxcIkNyZWF0ZUludm9pY2VcIjp0cnVlLFwiVmlld0ludm9pY2luZ1wiOnRydWUsXCJFZGl0SW52b2ljaW5nXCI6dHJ1ZSxcIkRlbGV0ZUludm9pY2luZ1wiOnRydWUsXCJDcmVhdGVNaXNjSW52b2ljZVwiOmZhbHNlLFwiVmlld0FSTWFuYWdlbWVudFwiOnRydWUsXCJFZGl0QmlsbGluZ1wiOnRydWUsXCJWaWV3UHVyY2hhc2luZ1wiOnRydWUsXCJWaWV3UmV2ZW51ZVwiOnRydWUsXCJWaWV3UmVwb3J0c1wiOnRydWUsXCJDb21wbGV0ZVdvcmtUaWNrZXRcIjp0cnVlLFwiQXBwcm92ZVdvcmtUaWNrZXRcIjp0cnVlLFwiRGVsZXRlV29ya1RpY2tldFwiOnRydWUsXCJTd2FwQXNOZWVkZWRTZXJ2aWNlc1wiOnRydWUsXCJQYXJ0aWFsT2NjdXJcIjp0cnVlLFwiTW92ZVdvcmtUaWNrZXRDb3N0c1wiOnRydWUsXCJWaWV3T3Bwb3J0dW5pdGllc1wiOnRydWUsXCJWaWV3TXlPcHBvcnR1bml0aWVzXCI6ZmFsc2UsXCJXaW5Db250cmFjdFwiOnRydWUsXCJXaW5Xb3JrT3JkZXJcIjp0cnVlLFwiTG9zZU9wcG9ydHVuaXRpZXNcIjp0cnVlLFwiQWRkQ3JlZGl0TWVtb1wiOnRydWUsXCJUaWNrZXRCdWxrRW1haWxcIjp0cnVlLFwiRWRpdEJ1ZGdldGVkSG91ckFuZFJldmVudWVcIjp0cnVlLFwiUmVwb3J0QWNjZXNzXCI6e30sXCJNb2RpZnlTZW50SW52b2ljZXNcIjp0cnVlLFwiQWRkQ3Jld0xlYWRlckNvbnRhY3RcIjp0cnVlLFwiT3ZlcnJpZGVUb3RhbENvc3RcIjp0cnVlLFwiRWRpdEVhcm5lZFJldmVudWVcIjp0cnVlLFwiVmlld0tQSU92ZXJoZWFkUmVjb3ZlcnlcIjp0cnVlLFwiVmlld0tQSUNsaWVudE1hbmFnZW1lbnRcIjp0cnVlLFwiVmlld0tQSVByb2ZpdExvc3NcIjp0cnVlLFwiVmlld0tQSUZvcmVjYXN0XCI6dHJ1ZSxcIlZpZXdLUElDb21wbGV0ZWRMYWJvckVmZmljaWVuY3lcIjp0cnVlLFwiVmlld0tQSVNhbGVzU2NvcmVDYXJkXCI6dHJ1ZSxcIlZpZXdTYWxlc1BpcGVsaW5lSW5zaWdodFwiOnRydWUsXCJWaWV3Q3VzdG9tZXJJc3N1ZXNJbnNpZ2h0XCI6dHJ1ZSxcIkNsb3NlTW9udGhcIjp0cnVlLFwiQXBwcm92ZUVxdWlwbWVudFwiOnRydWUsXCJEaXNwb3NlRXF1aXBtZW50XCI6dHJ1ZSxcIkRlbGV0ZUVxdWlwbWVudFwiOnRydWUsXCJFcXVpcG1lbnRBZG1pblwiOnRydWUsXCJNYXJrRXF1aXBtZW50SW5TZXJ2aWNlXCI6dHJ1ZSxcIk1hcmtFcXVpcG1lbnRPdXRPZlNlcnZpY2VcIjp0cnVlLFwiUHVyY2hhc2VFcXVpcG1lbnRcIjp0cnVlLFwiUmVxdWVzdEVxdWlwbWVudFwiOnRydWUsXCJWaWV3RXF1aXBtZW50XCI6dHJ1ZSxcIkVzdGltYXRlQ3VzdG9tQ29sdW1uXCI6dHJ1ZSxcIlRyaWdnZXJBdXRvRXhwZW5zZUNyZWF0aW9uXCI6dHJ1ZSxcIlJvdXRlU2NoZWR1bGluZ1wiOnRydWUsXCJBZGRGdWVsUmF0ZVwiOnRydWUsXCJGdWVsQ29zdFJlcG9ydFwiOnRydWUsXCJNYW5hZ2VDdXN0b21GaWVsZHNcIjp0cnVlLFwiUHJvY2Vzc0VsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJWb2lkRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIlJlZnVuZEVsZWN0cm9uaWNQYXltZW50c1wiOnRydWUsXCJFeHBpcmluZ0VsZWN0cm9uaWNQYXltZW50TWV0aG9kc0FsZXJ0c1wiOnRydWUsXCJSZWplY3RlZEVsZWN0cm9uaWNQYXltZW50c0FsZXJ0c1wiOnRydWUsXCJBbm51YWxSZW5ld2Fsc1wiOnRydWUsXCJWaWV3Q29tcGFuaWVzXCI6dHJ1ZSxcIkVkaXRDb21wYW5pZXNcIjp0cnVlLFwiQWRkQ29tcGFuaWVzXCI6dHJ1ZSxcIkNhbmNlbENvbnRyYWN0XCI6dHJ1ZSxcIkNhbmNlbFdvcmtPcmRlclwiOnRydWUsXCJNb2RpZnlTT1ZBZnRlck9wcG9ydHVuaXR5SXNXb25cIjp0cnVlLFwiQ2hhbmdlQXNzaWduZWRQcm9wZXJ0eUJyYW5jaFwiOnRydWUsXCJNYW5hZ2VVc2VyUm9sZXNcIjp0cnVlLFwiRWRpdEVxdWlwbWVudENvc3RBbmRIb3Vyc1wiOnRydWUsXCJDcmVhdGVFcXVpcG1lbnRJbnNwZWN0aW9uc1wiOnRydWUsXCJSZWNlaXZlUmVjZWlwdFwiOnRydWUsXCJNYW5hZ2VOb3RpZmljYXRpb25zU3lzdGVtXCI6dHJ1ZSxcIk1hbmFnZU5vdGlmaWNhdGlvbnNCcmFuY2hcIjp0cnVlLFwiUmVwb3J0V2ViRGVzaWduZXJcIjp0cnVlLFwiVmlld0ludmVudG9yeUxvY2F0aW9uc1wiOnRydWUsXCJFZGl0SW52ZW50b3J5TG9jYXRpb25zXCI6dHJ1ZSxcIlJvbGVQZXJtaXNzaW9uXCI6W10sXCJMb2NhbEJyYW5jaEFkbWluXCI6ZmFsc2UsXCJIYXNBbnlSZXBvcnRBY2Nlc3NcIjpmYWxzZX0iLCJBc3BpcmVTeXN0ZW1TZXR0aW5ncyI6IntcIkNvbXBhbnlOYW1lXCI6XCJJbmNyZWRpc2NhcGUgVUFUXCIsXCJFc3RpbWF0ZUxpY2Vuc2VcIjp0cnVlLFwiVGlja2V0TWFuYWdlbWVudExpY2Vuc2VcIjp0cnVlLFwiRXN0aW1hdGluZ1N0YWdpbmdcIjpmYWxzZSxcIkludm9pY2luZ0xpY2Vuc2VcIjp0cnVlLFwiQVJNYW5hZ2VtZW50TGljZW5zZVwiOnRydWUsXCJCaWxsaW5nRW1haWxGcm9tQWNjb3VudE93bmVyXCI6ZmFsc2UsXCJQYXljaGV4SW5jbHVkZURhdGVzXCI6dHJ1ZSxcIlJlcXVpcmVVbmlxdWVWZW5kb3JJbnZvaWNlTnVtYmVyXCI6ZmFsc2UsXCJSZXN0cmljdEVkaXRpbmdFbXBsb3llZXNcIjpmYWxzZSxcIkNyZWF0ZVByb3BlcnR5RnJvbUNvbnRhY3RcIjp0cnVlLFwiRW5hYmxlRWxlY3Ryb25pY1NpZ25hdHVyZXNcIjp0cnVlLFwiTWFzdGVyU3lzdGVtXCI6ZmFsc2UsXCJTbm93TW9kZVwiOnRydWUsXCJPcHBvcnR1bml0eUJyYW5jaE92ZXJyaWRlXCI6dHJ1ZSxcIlJvdW5kQ2xvY2tJbk91dFRpbWVzXCI6ZmFsc2UsXCJPTEFQUGl2b3RFbmFibGVkXCI6dHJ1ZSxcIkRpc2FibGVBdXRvbWF0aWNBcHByb3ZhbFwiOnRydWUsXCJEaXNhYmxlTW9iaWxlQ3Jld01hbmFnZW1lbnRcIjpmYWxzZSxcIkRpc2FibGVEZWxldGlvbk9mV29ya1RpY2tldHNcIjpmYWxzZSxcIkFsbG93U3ViVG9Mb2dpblwiOnRydWUsXCJIaWRlU2NoZWR1bGVQcm9ncmVzc0JhclwiOmZhbHNlLFwiV2Fybk9uRWFybHlMdW5jaENsb2NraW5cIjoyLFwiQ2FsaWZvcm5pYVRpbWVQcm9tcHRzXCI6ZmFsc2UsXCJJbnZvaWNpbmdBc3Npc3RhbnRSZXF1aXJlQmlsbGluZ0NvbXBhbnlcIjp0cnVlLFwiRW5mb3JjZUJyYW5jaEFkbWluQWRtaW5pc3RyYXRpb25TZWN1cml0eVwiOnRydWUsXCJPVENhbGN1bGF0aW9uXCI6XCJPdmVycmlkZSBQYXljb2RlXCIsXCJFcXVpcG1lbnRSZWFkaW5nQ2xvY2tPdXRQcm9tcHRcIjpcIkVuZCBvZiBEYXlcIixcIlNob3dOZXRHcm9zc01hcmdpbk9uRXN0aW1hdGluZ1NjcmVlblwiOnRydWUsXCJTaG93T25seUdyb3NzTWFyZ2lub25Fc3RpbWF0aW5nU2NyZWVuXCI6ZmFsc2UsXCJDcmVhdGVFcXVpcG1lbnRSZWFkaW5nc1wiOnRydWUsXCJJbmNsdWRlRHJpdmVUaW1lV2hlbkxvZ2dpbmdFcXVpcG1lbnRDcmV3TW9iaWxlXCI6dHJ1ZSxcIkVuYWJsZU5lZ2F0aXZlQ2hhbmdlT3JkZXJzXCI6dHJ1ZSxcIkVuYWJsZUN1c3RvbWVyUG9ydGFsXCI6dHJ1ZSxcIkRlZmF1bHRHRU9QZXJpbWV0ZXJcIjo1MDAuMCxcIkVuYWJsZUFzcGlyZUdQU0ludGVncmF0aW9uXCI6dHJ1ZSxcIkVuYWJsZUVxdWlwbWVudE1vZHVsZUFkZE9uXCI6dHJ1ZSxcIkdQU0ludGVncmF0aW9uUHJvdmlkZXJcIjozLFwiRW5hYmxlRWxlY3Ryb25pY1BheW1lbnRzXCI6dHJ1ZSxcIkVuYWJsZVNpdGVPbmVcIjpmYWxzZSxcIkJyZWFrVGltZVwiOjAuNSxcIlBheWNoZXhFeHBvcnRGb3JtYXRcIjpcIkRlZmF1bHQgQ1NWXCIsXCJFbmFibGVQYXJ0aWFsVGltZU9uU3ViUG9ydGFsXCI6dHJ1ZSxcIkVuYWJsZVBhcnRpYWxUaW1lT25DcmV3TW9iaWxlXCI6dHJ1ZSxcIkVuYWJsZUxhbmRzY2FwZUh1YkludGVncmF0aW9uXCI6dHJ1ZSxcIkRpc3BsYXlUYXhPbkVzdGltYXRlXCI6dHJ1ZSxcIkxpbmtTY2hlZHVsZW9mVmFsdWV0b1NlcnZpY2VCeURlZmF1bHRcIjpmYWxzZSxcIkVuYWJsZVdlYXRoZXJtYXRpY0ludGVncmF0aW9uXCI6dHJ1ZSxcIkFkdmFuY2VkU2VhcmNoU2VsZWN0VG9wTnVtYmVyXCI6NTAwMCxcIkVuYWJsZU92ZXJVbmRlckFkanVzdG1lbnRzXCI6dHJ1ZSxcIkRlZmF1bHREaXZpc2lvbklERm9yV29ya09yZGVyc1wiOjAsXCJEZWZhdWx0Rm9udFwiOlwiVmVyZGFuYSxzYW5zLXNlcmlmXCIsXCJEZWZhdWx0Rm9udFNpemVcIjpcIjE0LjAwXCIsXCJDcmV3TGVhZGVyUm9sZUlEXCI6MTIwMixcIlJlcXVpcmVOb09wZW5JbnZvaWNlc0NoZWNrXCI6dHJ1ZSxcIlByb2R1Y3RUaWVyXCI6MCxcIkNhbkFjY2Vzc0FQSXNcIjpmYWxzZSxcIkhhc0ZhY2lhbFJlY1wiOmZhbHNlLFwiRW5hYmxlVGFrZW9mZkludGVncmF0aW9uXCI6dHJ1ZSxcIlRha2VvZmZJbnRlZ3JhdGlvblR5cGVcIjo3LFwiRGVmYXVsdFByb3BlcnR5VGFrZW9mZlByb3ZpZGVyXCI6NCxcIkRlZmF1bHRFc3RpbWF0ZVRha2VvZmZQcm92aWRlclwiOjQsXCJFbmFibGVXZWJSZXBvcnREZXNpZ25lclwiOmZhbHNlLFwiQXp1Z2FDdXN0b21lcklEXCI6MTA1OSxcIkVuYWJsZUNyZXdNZW1iZXJDbG9ja0luV2l0aG91dENyZXdMZWFkZXJcIjpmYWxzZSxcIkVuYWJsZUVPTVJlcG9ydFwiOmZhbHNlLFwiVXNlT3Bwb3J0dW5pdHlJdGVtRGlzcGxheU5hbWVPbkludm9pY2VcIjp0cnVlLFwiRW5hYmxlVmlzaXRDaGVja2xpc3RzXCI6dHJ1ZSxcIlRpbWVab25lXCI6XCJBbWVyaWNhL0NoaWNhZ29cIixcIkZpcnN0RGF5T2ZXZWVrXCI6XCJNb25kYXlcIixcIklub3ZhRW5hYmxlZFwiOnRydWUsXCJQVE9WaXNpYmxlXCI6dHJ1ZSxcIk1hcmtldGluZ1Byb0ludGVncmF0aW9uXCI6ZmFsc2UsXCJNYXJrZXRpbmdQcm9WZXJzaW9uXCI6bnVsbCxcIkVuYWJsZUF1dG9UaW1lQWNjZXB0YW5jZUNvbmZpZ1wiOmZhbHNlLFwiRW5hYmxlQXV0b1RpbWVBY2NlcHRhbmNlXCI6ZmFsc2UsXCJFbnRlcnByaXNlQWRtaW5UeXBlXCI6MH0iLCJGb3JiaWRkZW4iOiIiLCJuYmYiOjE3MDU0MjgyNTEsImV4cCI6MTcwNTUxNDY1MSwiaWF0IjoxNzA1NDI4MjUxfQ.Ray35HwIZrMEFZz_MmEAECDy75zr30sOGceKUSyldQw' \
  --header 'accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json'

$pageNumber

This parameter is not an Odata query option. It is a customized pagination function that allows you to designate the results page number that should be returned. It can be used independently or with the $limit query option. 

• Integers only.
• Both $pageNumber and $limit are used in conjunction. 

$limit

 This query option must be used with $pageNumbe to limit the number of items returned on a page. 

• Integers only.
• Use both $pageNumber and $limit are used in conjunction.  $limit should follow $pageNumber .

Using multiple query options

All query options can be combined. To do so successfully, abide by the syntax rules and don't duplicate query options in the same request. 

Nested Collections 

A nested collection is a method of organizing and structuring information that is easier to interact with, as it requires fewer requests when the request is properly created. It refers to a group of entities (fields and or properties) embedded within another with which it is associated. Within a nested collection, a hierarchical relationship is formed between entities - there is a parent attribute that can be used independently in a one-to-one relationship that owns a nested collection beneath it. 

    The nested collection belonging to the parent entity can also have its nested collections. Each set of nested collections is typically categorized as a level, characterized by its relative closeness to the parent entity. Nested endpoints are usually queried with the $expand option in combination with the $filter and $select query options. 

$expand

The $expand query option is particularly helpful when used with endpoints with a one-to-many relationship defined throughout their properties because it allows you to retrieve information nested within a property from one request. When using the $expand query option, the following criteria must be met: 

• A $select, $filter, or another $expand query option must also be used. 
• All fields will be returned if the $select field is not used.  

Good practice 

• Avoid using  $orderby and  $top query parameters for large data sets. 
• Filtering integers instead of string fields is optimal.