Projects

Search for projects

post/api/Projects/Search

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Projects/Search
  • Auth: API key in header Authorization

Request body

takeinteger

Number of items to take

pageinteger

Page (Fetches from [Page * Take] to [(Page + 1) * Take])

projectIdstring nullable

Project ID

projectNumberstring nullable

Project number

stepNamestring nullable

Filter by current step name

emailstring nullable

Customer e-mail

phonestring nullable

Customer phone number

storeContactstring nullable

Search projects by store contact

contactPersonEmailsstring[] nullable

Filter by contact person emails

contactPersonPhonesstring[] nullable

Filter by contact person phone numbers

customerIdstring nullable

Customer name

customerNamestring nullable

Customer name

postalCodestring nullable

Customer postal code

citystring nullable

Customer city

partnerNamestring nullable

Partner name

partnerIdstring nullable

Partner ID

statusesstring[] nullable

Statuses (E.g. New, Completed, WorkflowCompleted, CancelledByCustomer etc)

querystring nullable

Search query

createdFromstring date-time nullable

Project created after date

createdTostring date-time nullable

Project created before date

modifiedFromstring date-time nullable

Project modified after date

modifiedTostring date-time nullable

Project modified before date

activeboolean

Search only active projects

storeIdsstring[] nullable

Filter by store IDs

projectTypeIdsstring[] nullable

Project type IDs

sortOrderstring nullable

Sort order

stepIdsstring[] nullable

Filter by current step ids

excludeRejectedPartnerIdsstring[] nullable

Filter by projects without rejected partner ids in list

rejectedPartnerIdsstring[] nullable

Filter projects by rejected partner ids in list

externalIdsstring[] nullable

Filter by external IDs

externalIdsProviderstring nullable

If set, only external IDs with given provider is returned

tagsstring[] nullable

Filter by tags

excludeTagsstring[] nullable

Exclude projects with tags

isUrgentboolean

If true, only projects with expired workflow steps (urgent) are returned

includeCommentsboolean nullable

If true or null - attaches comments to projects before returning

Response

Success

totalHitsinteger

Total number of hits

scrollIdstring nullable

The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents

isValidboolean

Deprecated

Changes

No recorded changes to this operation across all 1 revision of this API.