Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
SWIFT BE logo

Topics

  • Introduction
  • Servers
  • Authentication

Endpoints

  • Auth
    • User Login POST
    • Authentification Check GET
    • Current User Infos GET
    • Passwordless Login with code GET
    • Passwordless get code POST
  • Courses
    • Add course Questions POST
    • Get All Public Courses GET
    • Add new course POST
    • Search For Public Course GET
    • Search For Course with ID GET
    • Modify Course PUT
    • Get All Courses With AUTH GET
    • Publish a course GET
    • Set a course as darft GET
    • Get My Committee Courses GET
  • Cpanel
    • Return Domains GET
    • Return Domains With Infos GET
    • Add new subdomain POST
    • Get all db GET
  • Files
    • Get A file GET
    • Add new file POST
    • Get My files GET
  • Otp
    • Generate OTP GET
    • Verifiy OTP code POST
    • OTP change enabled status PUT
    • Validate OTP code POST
  • Sms
    • Send single SMS POST
    • Send Bulk SMS POST
  • Team
    • Update User Infos By ID PUT
    • Reset User Password By Admin POST
  • Users
    • Get current user activity Log GET
    • Set Current User Avatar POST
    • Get My Commitee Users GET
    • Get a User By ID GET
    • Change a User Status PUT
    • Register new user POST
    • Reset user password Req GET
    • Change password PUT
    • Reset user password POST
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
SWIFT BE logo

Search For Public Course

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown
GET /courses/search
Bearer auth

Query parameters

  • courseId string
  • courseTitle string
  • courseSubTitle string
  • description string
  • subject string
  • price string
  • location string
  • courseType string
  • sectionOfMatter string
  • language string
  • region string
  • city string
  • contactPerson string
  • contactPhone string
  • contactEmail string

Responses

  • 200

    OK

    Hide headers attributes Show headers attributes
    • Cross-Origin-Embedder-Policy string
    • Cross-Origin-Opener-Policy string
    • Cross-Origin-Resource-Policy string
    • Origin-Agent-Cluster string
    • Referrer-Policy string
    • Strict-Transport-Security string
    • X-Content-Type-Options string
    • X-DNS-Prefetch-Control string
    • X-Download-Options string
    • X-Frame-Options string
    • X-Permitted-Cross-Domain-Policies string
    • X-XSS-Protection integer
    • Access-Control-Allow-Origin string
    • Access-Control-Allow-Credentials boolean
    • Retry-After number
    • X-RateLimit-Limit integer
    • X-RateLimit-Remaining integer
    • X-RateLimit-Reset string
    • x-powered-by string
    • Content-Type string
    • Content-Length integer
    • ETag string
    • Date string
    • Connection string
    • Keep-Alive string
GET /courses/search
curl \
 -X GET http://localhost:3003/api/dev/courses/search \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
# Headers
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Resource-Policy: same-origin
Origin-Agent-Cluster: ?1
Referrer-Policy: no-referrer
Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Retry-After: 599.866
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: Tue Sep 05 2023 16:54:10 GMT+0100 (Central European Standard Time)
x-powered-by: TUNISIAN RED CRESSCENT
Content-Type: application/json; charset=utf-8
Content-Length: 5458
ETag: W/"1552-0R3+ja4GMfuXtopJgSmprPCdIrU"
Date: Tue, 05 Sep 2023 15:44:10 GMT
Connection: keep-alive
Keep-Alive: timeout=5

# Payload
{
  "code": 200,
  "result": {
    "count": 3,
    "courses": [
      {
        "courseId": "2c9646b7-4e2e-451c-97a9-932905ae9b48",
        "DoC": "2023-09-04T05:56:00.000Z",
        "createdBy": {
          "name": "Mohamed Hassen",
          "email": "mohamedhassen.jahha@assistdigital.com",
          "phone": "58076667",
          "avatar": null,
          "userId": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "lastName": "JAHHA",
          "phoneCode": "+216",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8"
        },
        "lastUpdatedBy": {
          "name": "Mohamed Hassen",
          "email": "mohamedhassen.jahha@assistdigital.com",
          "phone": "58076667",
          "avatar": null,
          "userId": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "lastName": "JAHHA",
          "phoneCode": "+216",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8"
        },
        "lastUpdate": null,
        "courseTitle": "Sample Course 1",
        "courseSubTitle": "Subtitle for Sample Course 1",
        "description": "Description of Sample Course 1",
        "subject": "Sample Subject 1",
        "price": 100,
        "dateStart": "2023-08-31T23:00:00.000Z",
        "dateEnd": "2023-09-29T23:00:00.000Z",
        "prerequisites": null,
        "keywords": "[]",
        "courseType": "FIRST-AID",
        "sectionOfMatter": "SECOURISME",
        "isPublic": 1,
        "accessCode": null,
        "isOpenToRegister": 1,
        "isOnline": 1,
        "language": "EN",
        "minAge": 18,
        "maxAge": 65,
        "minParticipants": 10,
        "maxParticipants": 20,
        "coverPicture": "sample-cover-image-url",
        "gallery": "{\"image1\": \"url1\", \"image2\": \"url2\"}",
        "location": "Sample Location",
        "region": "Sample Region",
        "city": "Sample City",
        "contactPerson": "John Doe",
        "contactPhone": "123-456-7890",
        "contactEmail": "john@example.com",
        "isCertified": 1,
        "isPublished": 0,
        "isPayableOnLine": 0,
        "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
        "isArchived": 0,
        "committee": {
          "city": "Tunis",
          "region": "Tunis",
          "adresse": "19, Rue d'Angleterre",
          "nameArabe": "الهيئة المركزية",
          "nameLatin": "Comité central",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "primaryEmail": "contact@croissant-rouge.tn",
          "primaryPhone": "+21671325572",
          "secondaryEmail": null,
          "secondaryPhone": "+21671320630"
        }
      },
      {
        "courseId": "5b0dd6b8-7440-4c5c-8292-124217cd77d0",
        "DoC": "2023-09-04T06:04:58.000Z",
        "createdBy": {
          "name": "Mohamed Hassen",
          "email": "mohamedhassen.jahha@assistdigital.com",
          "phone": "58076667",
          "avatar": null,
          "userId": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "lastName": "JAHHA",
          "phoneCode": "+216",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8"
        },
        "lastUpdatedBy": {
          "name": "Mohamed Hassen",
          "email": "mohamedhassen.jahha@assistdigital.com",
          "phone": "58076667",
          "avatar": null,
          "userId": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "lastName": "JAHHA",
          "phoneCode": "+216",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8"
        },
        "lastUpdate": null,
        "courseTitle": "Formation Premier secours",
        "courseSubTitle": "Premier Niveau",
        "description": "Formation Premier niveau",
        "subject": "FPS",
        "price": 30,
        "dateStart": "2023-09-03T23:00:00.000Z",
        "dateEnd": "2023-09-29T23:00:00.000Z",
        "prerequisites": null,
        "keywords": "[]",
        "courseType": "FIRST-AID",
        "sectionOfMatter": "SECOURISME",
        "isPublic": 1,
        "accessCode": null,
        "isOpenToRegister": 1,
        "isOnline": 1,
        "language": "FR",
        "minAge": 18,
        "maxAge": 65,
        "minParticipants": 10,
        "maxParticipants": 20,
        "coverPicture": null,
        "gallery": "[]",
        "location": "Maison des associassions",
        "region": "Ben Arous",
        "city": "Rades",
        "contactPerson": "Mohamed hassen JAHHA",
        "contactPhone": "+21658076667",
        "contactEmail": "john.doe@example.com",
        "isCertified": 1,
        "isPublished": 0,
        "isPayableOnLine": 0,
        "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
        "isArchived": 0,
        "committee": {
          "city": "Tunis",
          "region": "Tunis",
          "adresse": "19, Rue d'Angleterre",
          "nameArabe": "الهيئة المركزية",
          "nameLatin": "Comité central",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "primaryEmail": "contact@croissant-rouge.tn",
          "primaryPhone": "+21671325572",
          "secondaryEmail": null,
          "secondaryPhone": "+21671320630"
        }
      },
      {
        "courseId": "ba4432ae-841f-4d20-ac0d-406854ae21d3",
        "DoC": "2023-09-04T06:00:05.000Z",
        "createdBy": {
          "name": "Mohamed Hassen",
          "email": "mohamedhassen.jahha@assistdigital.com",
          "phone": "58076667",
          "avatar": null,
          "userId": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "lastName": "JAHHA",
          "phoneCode": "+216",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8"
        },
        "lastUpdatedBy": {
          "name": "Mohamed Hassen",
          "email": "mohamedhassen.jahha@assistdigital.com",
          "phone": "58076667",
          "avatar": null,
          "userId": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "lastName": "JAHHA",
          "phoneCode": "+216",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8"
        },
        "lastUpdate": null,
        "courseTitle": "Sample Course 1",
        "courseSubTitle": "Subtitle for Sample Course 1",
        "description": "Description of Sample Course 1",
        "subject": "Sample Subject 1",
        "price": 100,
        "dateStart": "2023-08-31T23:00:00.000Z",
        "dateEnd": "2023-09-29T23:00:00.000Z",
        "prerequisites": null,
        "keywords": "[]",
        "courseType": "FIRST-AID",
        "sectionOfMatter": "SECOURISME",
        "isPublic": 1,
        "accessCode": null,
        "isOpenToRegister": 1,
        "isOnline": 1,
        "language": "EN",
        "minAge": 18,
        "maxAge": 65,
        "minParticipants": 10,
        "maxParticipants": 20,
        "coverPicture": "sample-cover-image-url",
        "gallery": "{\"image1\": \"url1\", \"image2\": \"url2\"}",
        "location": "Sample Location",
        "region": "Sample Region",
        "city": "Sample City",
        "contactPerson": "John Doe",
        "contactPhone": "123-456-7890",
        "contactEmail": "john@example.com",
        "isCertified": 1,
        "isPublished": 0,
        "isPayableOnLine": 0,
        "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
        "isArchived": 0,
        "committee": {
          "city": "Tunis",
          "region": "Tunis",
          "adresse": "19, Rue d'Angleterre",
          "nameArabe": "الهيئة المركزية",
          "nameLatin": "Comité central",
          "committeesID": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
          "primaryEmail": "contact@croissant-rouge.tn",
          "primaryPhone": "+21671325572",
          "secondaryEmail": null,
          "secondaryPhone": "+21671320630"
        }
      }
    ]
  }
}
Response examples (200)
# Headers
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Resource-Policy: same-origin
Origin-Agent-Cluster: ?1
Referrer-Policy: no-referrer
Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Retry-After: 599.866
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: Tue Sep 05 2023 16:54:10 GMT+0100 (Central European Standard Time)
x-powered-by: TUNISIAN RED CRESSCENT
Content-Type: application/json; charset=utf-8
Content-Length: 5458
ETag: W/"1552-0R3+ja4GMfuXtopJgSmprPCdIrU"
Date: Tue, 05 Sep 2023 15:44:10 GMT
Connection: keep-alive
Keep-Alive: timeout=5

# Payload
{}